bugGNU Octave - Bugs: bug #34186, Documentation is not an options...

 
 

bug #34186: Documentation is not an options extra

Submitter:  None
Submitted:  Thu 01 Sep 2011 06:59:26 AM UTC
   
 
Category:  Plotting with gnuplot Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Documentation
Status:  Invalid / Not an Octave Bug Assigned to:  None
Originator Name:  Originator Email:  -email is unavailable-
Open/Closed:  * Closed Release:  * 3.4.0
Operating System:  * Any Fixed Release:  None
Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Thu 01 Sep 2011 06:59:26 AM UTC, original submission:  

re bug #34148: comment #9

>> I get the impression you're trying to fit a square peg into a round hole and filing bug reports over the squareness of the peg.



A lot of the problem is that your hole is now an elipse, you have just failed to document the fact. There are unseen changes to major and minor axes of your hole and even the round pegs don't fit any more.



doc plotyy() does not mention the "current axis" concept nor the fact that its use will affect other functions such as ylabel etc.

doc ylabel does not mention it's behaviour depends upon previous use of plotyy() nor the idea of "current axis".

     Specify x-, y-, or z-axis labels for the current axis.  If H is
     specified then label the axis defined by H.  The optional return
     value H provides a handle to the created label.


Neither does doc axes()

 -- Function File:  axes (H)
     Create an axes object and return a handle to it.


The presence of the second x axis is undocumented and not only is it useless it requires identical manual operation to both x axes otherwise they produce jumbled output that also affects the grid , if visible.


There are issues with your use of gnuplot but even understanding what octave is supposed to produce is not possible with the current state of the man and doc .

You seem to think you users are telepathic or are going to dig into the source code to understand how to use the program.

You may find it helps save your time and everyone elses if you document any changes to function behaviour at the same time as you commit changes to source. Adding one line to the above functions doc would have taken less time than multiple replies to confused bug reports.

  • Documentation is not an options extra to be put off for a rainy day. *
Anonymous

 

(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 bpabbott (Updated the item)
  • -email is unavailable- added by None (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.

     

    Follow 2 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2011-09-01 bpabbott StatusNone Invalid / Not an Octave Bug
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-02a9.
    Corresponding source code