Talk:Help text style guide: Difference between revisions

From Octave
Jump to navigation Jump to search
(→‎Yes-or-no flag: new section)
 
(suggestion on extra macro explanations)
 
(2 intermediate revisions by 2 users not shown)
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)

Latest revision as of 16:29, 2 February 2024

Yes-or-no flag[edit]

Shouldn't we use logical instead of a double for such variable? --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. --carandraug (talk) 04:43, 5 February 2017 (PST)


expanding on common @ codes[edit]

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. Nrjank (talk) 16:29, 2 February 2024 (UTC)