Template:Note/Doc

From Octave
< Template:Note
Revision as of 03:08, 7 December 2011 by Carandraug (talk | contribs) (make better sentence)
Jump to navigation Jump to search

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. 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.}}

Will produce:

Info icon.svg
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 help @polynomial/polynomial. This second method is the only means of getting help for the overloaded methods and functions of the class.