diff options
| author | Sean Whitton <spwhitton@spwhitton.name> | 2022-03-31 11:49:39 -0700 |
|---|---|---|
| committer | Sean Whitton <spwhitton@spwhitton.name> | 2022-03-31 11:49:39 -0700 |
| commit | e13606f436c4b7ad2b9a39e2f910f05fbc6a5043 (patch) | |
| tree | ce17e75305f429f091944a06d29708b1ecac602f /CONTRIBUTING.rst | |
| parent | 20a017681dce547f0246651e8152aaf84c0c0f27 (diff) | |
| download | consfigurator-e13606f436c4b7ad2b9a39e2f910f05fbc6a5043.tar.gz | |
CONTRIBUTING.rst: refer to Emacs Lisp documentation conventions
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 27d7ed4..259b50a 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -75,6 +75,10 @@ Code style packages -- though not ASDF systems -- in BLOCK CAPITALS, without any quotation marks. +- Follow the conventions detailed in sections "Tips for Documentation Strings" + and "Tips on Writing Comments" of the *GNU Emacs Lisp Reference Manual*, to + the extent that they are applicable to Common Lisp. + - Avoid complicating property definitions to include updates to file ownership, and the like, when it's possible instead to switch to the target user and apply a simpler version of the property. For example, instead of |