[Octave-patch-tracker] [patch #9056] documentation for Java methods and fieldnames

[Mike Miller]

Update of patch #9056 (project octave):

                  Status:                    None => Done                   
             Open/Closed:                    Open => Closed                 

    _______________________________________________________

Follow-up Comment #2:

Hi Ernst. Thank you for your patch. A lot of the changes you made in this
patch are word choice and don't materially improve the documentation (in my
opinion). The strings inside of Texinfo @var{} commands should be all
lowercase. And when a function can return different numbers of return values,
we usually try to declare the common behavior with the inputs first, and then
show the difference when one or more output arguments are used.

I tried to carefully extract the spirit of your changes, and came up with
these points:

* Use the name "javaclassname" instead of "jclassname" to be clearer
* Use the terminology "fields" to refer to data members in Java classes
* Clarify that methods("classname") can be the name of either an Octave class
or a Java class

And I added to that the clarification that methods() can be called with or
without a return value for different behavior.

Here is what I pushed to the default branch instead of, but inspired by, your
patch:

http://hg.savannah.gnu.org/hgweb/octave/rev/44244c9c177f
http://hg.savannah.gnu.org/hgweb/octave/rev/6c94c7bd55e7

I hope these changes address what you were hoping to accomplish. Please also
note the commit message guidelines in Appendix D and at
http://wiki.octave.org/Commit_message_guidelines.

    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/patch/?9056>

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