1,847
edits
Help text style guide: Difference between revisions
Jump to navigation
Jump to search
→Ellipsis (...): Update deftypefn to current standards.
Franklin Yu (talk | contribs) (→TexInfo: improve external link: the new link allows user to choose from single-page manual and one-page-per-node manual (and even more); HTTPS is more secure) |
(→Ellipsis (...): Update deftypefn to current standards.) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 178: | Line 178: | ||
==== Ellipsis (...) ==== | ==== Ellipsis (...) ==== | ||
Ellipsis are frequently used in octave help text, | Ellipsis are frequently used in octave help text, especially when defining a function API. Use the {{Codeline|<nowiki>@dots{}</nowiki>}} rather than three dots. | ||
{{Code||<pre> | {{Code||<pre> | ||
@deftypefn { | @deftypefn {} {} imhist (@var{I}) | ||
@deftypefnx { | @deftypefnx {} {[@var{counts}, @var{x}] =} imhist (@dots{}) | ||
</pre>}} | </pre>}} | ||
==== Matlab ==== | ==== Matlab ==== | ||
Sometimes it is | Sometimes it is needed to mention Matlab in the help text. An example might be to mention that a weird behavior needs to be kept for Matlab compatibility. In such case, small caps should be used. For example, the following is used in the {{Codeline|length}} help text: | ||
{{Code||<pre> | {{Code||<pre> | ||
| Line 192: | Line 192: | ||
greater (this odd definition is used for compatibility with @sc{matlab}). | greater (this odd definition is used for compatibility with @sc{matlab}). | ||
</pre>}} | </pre>}} | ||
[[Category:Development]] | |||