diff options
| author | Jonas Bernoulli <jonas@bernoul.li> | 2020-08-08 13:49:50 +0200 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2020-08-09 21:14:36 -0300 |
| commit | e63f37a4a90c5d2a399a99a0566b6e1dfea263aa (patch) | |
| tree | 925c23fe8cd313d5fbd77708303ebe4d3f5335a2 /bindings/python-cffi/notmuch2/_query.py | |
| parent | c4541353765dec837c1c2f912b1bf6661827429c (diff) | |
emacs: Improve doc-strings
- The first sentence should fit on the first line in full. This is
even the case when that causes the line to get a bit long. If it
gets very long, then it should be made shorter.
- Even even the second sentence would fit on the first line, if it
just provides some details, then it shouldn't be done.
- Symbols are quoted like `so'.
- There is no clear rule on how to (not) quote non-atomic
s-expressions, but quoting like '(this) is definitely weird.
- It is a good idea to remember that \" becomes " and to take
that in mind when adjusting the automatic filling by hand.
- Use the imperative form.
- Arguments are written in all uppercase.
Diffstat (limited to 'bindings/python-cffi/notmuch2/_query.py')
0 files changed, 0 insertions, 0 deletions