Document that 3rd person verb forms should be used in the manual
See https://github.com/wxWidgets/wxWidgets/pull/1473
This commit is contained in:
parent
fbe651731c
commit
72272f5901
@ -58,6 +58,10 @@ Important Dos and Don'ts
|
||||
|
||||
DO:
|
||||
|
||||
- use present tense verbs in 3rd person singular form to describe functions,
|
||||
i.e. write "Returns the answer to life, universe and everything", rather than
|
||||
the imperative mood used in Git commit message ("Return the answer ...").
|
||||
|
||||
- Doxygen supports both commands in the form \command and @command;
|
||||
all wxWidgets documentation uses the @command form.
|
||||
Follow strictly this rule.
|
||||
|
Loading…
Reference in New Issue
Block a user