Template:Note/Doc: Difference between revisions

Template:Note/Doc (edit)

Revision as of 23:08, 15 December 2011

645 bytes removed , 15 December 2011

prettier format and simpler example

Carandraug

Bureaucrats, Administrators

659

edits

@@ 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]].
-Example:<br>
+Example:
-<nowiki>{{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 {{Codeline|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:
-{{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 {{Codeline|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.}}
+:{{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>