Browse files

Mention docstrings.

  • Loading branch information...
1 parent cea5bef commit ffead07e47d2e37bdaa6492a9df3edb5d02c8a6a heller committed Jun 4, 2009
Showing with 11 additions and 1 deletion.
  1. +11 −1 HACKING
@@ -141,7 +141,17 @@ Norvig and Pitman's _Tutorial on Good Lisp Programming Style_:
For Emacs Lisp, we try to follow the _Tips and Conventions_ in
Appendix D of the GNU Emacs Lisp Reference Manual (see Info file
-`elisp', node `Tips').
+`elisp', node `Tips').
+We use Emacs conventions for docstrings: the first line should be a
+complete sentence to make the output of `apropos' look good. We also
+use imperative verbs.
+The biggest problem with SLIME's code base is feature creep. Keep in
+mind that the Right Thing isn't always the Smart Thing. If you can't
+find an elegant solution to a problem then you're probably solving the
+wrong problem. It's often a good idea to simplify the problem and to
+ignore rarely needed cases.
Remember that to rewrite a program better is the sincerest form of
code appreciation. When you can see a way to rewrite a part of SLIME

0 comments on commit ffead07

Please sign in to comment.