Template:Note/Doc: Difference between revisions

From Octave
Jump to navigation Jump to search
(octavified example)
m (Capitalize first letter.)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This template is for items which should be noted by the user, but are not important enough to be a [[Template:Warning|Warning]].
This template is for items which should be noted by the user, but are not important enough to be a [[Template:Warning|Warning]].


Example:<br>
Example:
<nowiki>{{Note|Note that methods of a class can be documented. The help for the constructor itself can be obtained with the constructor name, that is for the polynomial constructor @code{help polynomial} will return the help string. Also the help can be obtained by restricting the search for the help to a particular class, for example {{Codeline|help @polynomial/polynomial}}. This second method is the only means of getting help for the overloaded methods and functions of the class.}}</nowiki>
:<nowiki>{{Note|Methods of a class can be documented but the only way to access their help text is by specifying the class as in {{Codeline|help @class/method}}.}}</nowiki>


Will produce:
Will produce:
{{Note|If the system <b>reports <i>that</i></b><i> it is out</i> of disk space, but still shows free space in the output of "df", the problem could by that the filesystem has run out of free inodes. In this case you might consider increasing this number when creating the filesystem.}}
:{{Note|Methods of a class can be documented but the only way to access their help text is by specifying the class as in {{Codeline|help @class/method}}.}}
<noinclude>[[Category:Template Documentation]]</noinclude>
 
[[Category:Template with documentation]]

Latest revision as of 14:08, 11 June 2019

This template is for items which should be noted by the user, but are not important enough to be a Warning.

Example:

{{Note|Methods of a class can be documented but the only way to access their help text is by specifying the class as in {{Codeline|help @class/method}}.}}

Will produce:

Info icon.svg
Methods of a class can be documented but the only way to access their help text is by specifying the class as in help @class/method.
Retrieved from "https://wiki.octave.org/wiki/index.php?title=Template:Note/Doc&oldid=12011"