diff options
| author | Sean Whitton <spwhitton@spwhitton.name> | 2022-03-31 11:50:17 -0700 |
|---|---|---|
| committer | Sean Whitton <spwhitton@spwhitton.name> | 2022-03-31 11:50:17 -0700 |
| commit | 12fe8a3d803c952b6330544b23cc54945d5b3aa8 (patch) | |
| tree | 2b48def0b50f15f9a4735c5fd3155c640ac345db /CONTRIBUTING.rst | |
| parent | e13606f436c4b7ad2b9a39e2f910f05fbc6a5043 (diff) | |
| download | consfigurator-12fe8a3d803c952b6330544b23cc54945d5b3aa8.tar.gz | |
CONTRIBUTING.rst: conventions for comments delimiting sections
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'CONTRIBUTING.rst')
| -rw-r--r-- | CONTRIBUTING.rst | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 259b50a..5df4771 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -77,7 +77,19 @@ Code style - 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. + the extent that they are applicable to Common Lisp. Additionally: + + - Place blank lines before and after comments whose lines begin with more + than two semicolons. + + - Separate major sections of files using the form feed character, like + this:: + + ^L + ;;;; Header for new major section + + - If the first major section of the file has a four-semicolon header, it + should not be preceded by the ``^L`` character. - Avoid complicating property definitions to include updates to file ownership, and the like, when it's possible instead to switch to the target |