Editing Talk:Help text style guide

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 2: Line 2:


Shouldn't we use [https://www.mathworks.com/help/matlab/logical-operations.html logical] instead of a double for such variable? --[[User:Franklin Yu|Franklin Yu]] ([[User talk:Franklin Yu|talk]]) 01:52, 5 February 2017 (PST)
Shouldn't we use [https://www.mathworks.com/help/matlab/logical-operations.html logical] instead of a double for such variable? --[[User:Franklin Yu|Franklin Yu]] ([[User talk:Franklin Yu|talk]]) 01:52, 5 February 2017 (PST)
: That is not a point for the help text, it is the behaviour of individual functions. The fact is that pretty much all functions will simply check if the value is non-zero. --[[User:Carandraug|carandraug]] ([[User talk:Carandraug|talk]]) 04:43, 5 February 2017 (PST)
== expanding on common @ codes  ==
It might be useful to expand on or add a section on the use of the more common @ codes / macros,  eg:  @group, @example, @result.  What type of things should use @code vs @math or @code{foo} vs @qcode{"foo"} (that last one i'm rarely sure about).  @ref vs @xref, and what should go in the reference part of those. when we prefer a @table vs a @itemize. I don't think we have to recreate a Texinfo manual, but there are probably a number of others that we could document here so they are used consistently according to our style preferences.  [[User:Nrjank|Nrjank]] ([[User talk:Nrjank|talk]]) 16:29, 2 February 2024 (UTC)
Please note that all contributions to Octave may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Octave:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)
Retrieved from "https://wiki.octave.org/Talk:Help_text_style_guide"