https://wiki.octave.org/wiki/index.php?title=Talk:Help_text_style_guide&feed=atom&action=historyTalk:Help text style guide - Revision history2024-03-28T10:05:45ZRevision history for this page on the wikiMediaWiki 1.39.2https://wiki.octave.org/wiki/index.php?title=Talk:Help_text_style_guide&diff=15054&oldid=prevNrjank: suggestion on extra macro explanations2024-02-02T16:29:57Z<p>suggestion on extra macro explanations</p>
<table style="background-color: #fff; color: #202122;" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 16:29, 2 February 2024</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l4">Line 4:</td>
<td colspan="2" class="diff-lineno">Line 4:</td></tr>
<tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br/></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br/></td></tr>
<tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>: 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)</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>: 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)</div></td></tr>
<tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">== expanding on common @ codes ==</ins></div></td></tr>
<tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">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)</ins></div></td></tr>
</table>Nrjankhttps://wiki.octave.org/wiki/index.php?title=Talk:Help_text_style_guide&diff=13106&oldid=prevSiko1056: Siko1056 moved page Talk:Help text to Talk:Help text style guide2020-06-10T06:17:33Z<p>Siko1056 moved page <a href="/Talk:Help_text" class="mw-redirect" title="Talk:Help text">Talk:Help text</a> to <a href="/Talk:Help_text_style_guide" title="Talk:Help text style guide">Talk:Help text style guide</a></p>
<table style="background-color: #fff; color: #202122;" data-mw="interface">
<tr class="diff-title" lang="en">
<td colspan="1" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td>
<td colspan="1" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 06:17, 10 June 2020</td>
</tr><tr><td colspan="2" class="diff-notice" lang="en"><div class="mw-diff-empty">(No difference)</div>
</td></tr></table>Siko1056https://wiki.octave.org/wiki/index.php?title=Talk:Help_text_style_guide&diff=9831&oldid=prevCarandraug: /* Yes-or-no flag */2017-02-05T12:43:31Z<p><span dir="auto"><span class="autocomment">Yes-or-no flag</span></span></p>
<table style="background-color: #fff; color: #202122;" data-mw="interface">
<col class="diff-marker" />
<col class="diff-content" />
<col class="diff-marker" />
<col class="diff-content" />
<tr class="diff-title" lang="en">
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">← Older revision</td>
<td colspan="2" style="background-color: #fff; color: #202122; text-align: center;">Revision as of 12:43, 5 February 2017</td>
</tr><tr><td colspan="2" class="diff-lineno" id="mw-diff-left-l2">Line 2:</td>
<td colspan="2" class="diff-lineno">Line 2:</td></tr>
<tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br/></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><br/></td></tr>
<tr><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>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)</div></td><td class="diff-marker"></td><td style="background-color: #f8f9fa; color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #eaecf0; vertical-align: top; white-space: pre-wrap;"><div>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)</div></td></tr>
<tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;"></ins></div></td></tr>
<tr><td colspan="2" class="diff-side-deleted"></td><td class="diff-marker" data-marker="+"></td><td style="color: #202122; font-size: 88%; border-style: solid; border-width: 1px 1px 1px 4px; border-radius: 0.33em; border-color: #a3d3ff; vertical-align: top; white-space: pre-wrap;"><div><ins style="font-weight: bold; text-decoration: none;">: 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)</ins></div></td></tr>
</table>Carandraughttps://wiki.octave.org/wiki/index.php?title=Talk:Help_text_style_guide&diff=9828&oldid=prevFranklin Yu: /* Yes-or-no flag */ new section2017-02-05T09:52:03Z<p><span dir="auto"><span class="autocomment">Yes-or-no flag: </span> new section</span></p>
<p><b>New page</b></p><div>== Yes-or-no flag ==<br />
<br />
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)</div>Franklin Yu