Nicolas Goaziou wrote:
>> +      ;; Test if destination is a numbered headline
> Missing full stop.

Small question about conventions for writing comments... Can I consider
the following to be the rule?

- If it's a *sentence* (like the above example, in the imperative form),
  begin with a capital and end with a dot.
- Otherwise (like ";; pattern found"), begin with a small letter and
  don't end with a dot.


Tips on writing comments found on
aren't very helpful IMHO, as you see things such as:

- "; there was there was a base version to which this looks like
  a subversion", that is a sentence with no capital nor dot...

- ";; Update mode line.", that is a sentence with both beginning capital
  and to.

- ";;;; The kill ring", an expression with a capital...

That page seems to be more on the usage of ";", ";;", ";;;" and ";;;;"
than on the usage of capitals and dots.

Best regards,

Sebastien Vauban

Reply via email to