From 12fe8a3d803c952b6330544b23cc54945d5b3aa8 Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Thu, 31 Mar 2022 11:50:17 -0700 Subject: CONTRIBUTING.rst: conventions for comments delimiting sections Signed-off-by: Sean Whitton --- CONTRIBUTING.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) (limited to 'CONTRIBUTING.rst') 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 -- cgit v1.2.3