659
edits
Help text style guide: Difference between revisions
→Special inserts: how to mention matlab
Carandraug (talk | contribs) (→Special inserts: how to mention matlab) |
|||
| Line 72: | Line 72: | ||
@deftypefn {Function File} {} imhist (@var{I}) | @deftypefn {Function File} {} imhist (@var{I}) | ||
@deftypefnx {Function File} {[@var{counts}, @var{x}] =} imhist (@dots{}) | @deftypefnx {Function File} {[@var{counts}, @var{x}] =} imhist (@dots{}) | ||
</pre>}} | |||
=== 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: | |||
{{Code||<pre> | |||
For matrix objects, the length is the number of rows or columns, whichever is | |||
greater (this odd definition is used for compatibility with @sc{matlab}). | |||
</pre>}} | </pre>}} | ||