Help text style guide: Difference between revisions

Jump to navigation Jump to search
→‎Ellipsis (...): Update deftypefn to current standards.
(→‎Ellipsis (...): Update deftypefn to current standards.)
 
(2 intermediate revisions by 2 users not shown)
Line 181: Line 181:


{{Code||<pre>
{{Code||<pre>
@deftypefn {Function File} {} imhist (@var{I})
@deftypefn {} {} imhist (@var{I})
@deftypefnx {Function File} {[@var{counts}, @var{x}] =} imhist (@dots{})
@deftypefnx {} {[@var{counts}, @var{x}] =} imhist (@dots{})
</pre>}}
</pre>}}


==== Matlab ====
==== Matlab ====
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:
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>

Navigation menu