We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent a06ebfc commit d40594dCopy full SHA for d40594d
README.md
@@ -511,10 +511,13 @@ you are helping to continue that tradition!
511
512
* Begin with a terse, complete sentence. Use imperative language. For
513
example, prefer "Verify" over "Verifies", and "Check" over "Checks".
514
+
515
* When a function takes arguments, mention what the arguments do,
516
whether they are required, and so on. Describe the arguments in
517
UPCASE, and order them as they are used.
518
519
* Always capitalize "Emacs".
520
521
* Emacs' built-in utility, Checkdoc, can automatically check
522
docstrings for adherence to coding conventions with the built-in
523
Checkdoc utility. Many in the Emacs community use Checkdoc by way of
0 commit comments