From e13606f436c4b7ad2b9a39e2f910f05fbc6a5043 Mon Sep 17 00:00:00 2001 From: Sean Whitton Date: Thu, 31 Mar 2022 11:49:39 -0700 Subject: CONTRIBUTING.rst: refer to Emacs Lisp documentation conventions Signed-off-by: Sean Whitton --- CONTRIBUTING.rst | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'CONTRIBUTING.rst') 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 -- cgit v1.2.3