bugGNU Octave - Bugs: bug #65412, Appendix C updates needed and...

 
 

bug #65412: Appendix C updates needed and Appendix D could use an overhaul

Submitter:  Nicholas Jankowski <nrjank>
Submitted:  Mon 04 Mar 2024 05:47:40 PM UTC
   
 
Category:  Documentation Severity:  2 - Minor
Priority:  5 - Normal Item Group:  Documentation
Status:  None Assigned to:  None
Originator Name:  Open/Closed:  * Open
Release:  * 9.0.90 Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Mon 04 Mar 2024 05:47:40 PM UTC, original submission:  

Looking at the backmatter of the docs, we don't have any obsolete functions listed after 5.1.0 (we deprecate for 2 major versions, so should there be any v6 or v7 items added to appendix C? is that just a matter of parsing the NEWS files?) 

Appendix D is Known Causes of Trouble has the sections:

"D.1 Actual Bugs we haven't fixed yet" - which just lists pager related issues and a recommendation users look to the PROJECTS file for enhancement ideas.  as we have (presently) 754 bug reports listed as Open&Confirmed, maybe we should just point to the bug tracker?

"D.2 Reporting Bugs" which points people up a section to see if we already know about it, then provides advice on determining if you actually found a bug, telling you to go submit one on  bugs.octaev.org, but don't email reports to 'help-octave'  (which we don't use much anymore). Also a decent section on how to make a useful bug report (probably could use a link to explaining making a MWE.), finally a section on sending patches that might not be entirely accurate anymore, including pointing to the no-longer-used ChangeLog files.

"D.3 How to Get Help with Octave" which mainly points to the mailing lists

"D.4 How to distinguish between Octave and Matlab" - which contains a functions script that can be run to programmatically tell if you're running Octave.   I think this should maybe be moved elsewhere.


I had never read through this Appendix before. We aren't the best at keeping our docs up to date, I'm wondering if this whole section, or most of it, should be streamlined, linked out, etc.




Nicholas Jankowski <nrjank>
Group Member

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach Files:
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by nrjank (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.

     

    Follows 1 latest change.

    Date Changed by Updated Field Previous Value => Replaced by
    2024-04-26 nrjank SummaryAppendices: C updates and D could use an overhaul Appendix C updates needed and Appendix D could use an overhaul

    Back to the top

    Powered by Savane 3.13-4b48.
    Corresponding source code