[Octave-bug-tracker] [bug #34186] Documentation is not an options extra

[anonymous]

URL:
  <http://savannah.gnu.org/bugs/?34186>

                 Summary: Documentation is not an options extra
                 Project: GNU Octave
            Submitted by: None
            Submitted on: Thu 01 Sep 2011 06:59:26 AM UTC
                Category: Plotting with gnuplot
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Documentation
                  Status: None
             Assigned to: None
         Originator Name: 
        Originator Email: address@hidden
             Open/Closed: Open
         Discussion Lock: Any
                 Release: 3.4.0
        Operating System: Any

    _______________________________________________________

Details:

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. *




    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?34186>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/