Editing Help text style guide
Jump to navigation
Jump to search
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 178: | Line 178: | ||
==== Ellipsis (...) ==== | ==== Ellipsis (...) ==== | ||
Ellipsis are frequently used in octave help text, | Ellipsis are frequently used in octave help text, specially when defining a function API. Use the {{Codeline|<nowiki>@dots{}</nowiki>}} rather than three dots. | ||
{{Code||<pre> | {{Code||<pre> | ||
@deftypefn | @deftypefn {Function File} {} imhist (@var{I}) | ||
@deftypefnx {} {[@var{counts}, @var{x}] =} imhist (@dots{}) | @deftypefnx {Function File} {[@var{counts}, @var{x}] =} imhist (@dots{}) | ||
</pre>}} | </pre>}} | ||
==== Matlab ==== | ==== Matlab ==== | ||
Sometimes it is | Sometimes it is need to mention matlab in the help text. For example, 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>}} | ||