From 72272f5901ab52cc6a15fbfef6bb85b0058a1050 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Tue, 20 Aug 2019 17:16:53 +0200 Subject: [PATCH] Document that 3rd person verb forms should be used in the manual See https://github.com/wxWidgets/wxWidgets/pull/1473 --- docs/contributing/how-to-add-class-documentation.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/contributing/how-to-add-class-documentation.md b/docs/contributing/how-to-add-class-documentation.md index cd9ad53821..329826219c 100644 --- a/docs/contributing/how-to-add-class-documentation.md +++ b/docs/contributing/how-to-add-class-documentation.md @@ -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.