[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Docstring of `decode-coding-string' a bit misleading about insertion
From: |
Richard M. Stallman |
Subject: |
Re: Docstring of `decode-coding-string' a bit misleading about insertion in buffer |
Date: |
Mon, 20 Oct 2008 13:04:12 -0400 |
I would just add "The point does not move." or somesuch.
In Emacs tradition, we treat "point" as a proper name
when it refers to the current editing location.
It should not have an article.
Thus, it is incorrect to write, "The point does not move".
It should be, "Point does not move".
However, that text uses a passive verb, which is also not good.
Documentation is clearer if it avoids the passive voice whenever
possible. So really this should say, "This does not move point."
If you see "the point" anywhere in Emacs documentation or comments,
referring to point, please fix it.
If you come across passive verbs in Emacs documentation or comments,
please see if it is possible to make the text shorter and clearer
using the active voice. Usually that does make an improvement. The
explicit subject required by the active voice often provides important
information which makes the text clearer, too.
- Docstring of `decode-coding-string' a bit misleading about insertion in buffer, Juanma Barranquero, 2008/10/17
- Re: Docstring of `decode-coding-string' a bit misleading about insertion in buffer, Kenichi Handa, 2008/10/20
- Re: Docstring of `decode-coding-string' a bit misleading about insertion in buffer, Juanma Barranquero, 2008/10/20
- Re: Docstring of `decode-coding-string' a bit misleading about insertion in buffer, Kenichi Handa, 2008/10/20
- Re: Docstring of `decode-coding-string' a bit misleading about insertion in buffer, Juanma Barranquero, 2008/10/20
- Re: Docstring of `decode-coding-string' a bit misleading about insertion in buffer, Kenichi Handa, 2008/10/20
- Re: Docstring of `decode-coding-string' a bit misleading about insertion in buffer, Eli Zaretskii, 2008/10/21
- Re: Docstring of `decode-coding-string' a bit misleading about insertion in buffer, Juanma Barranquero, 2008/10/21
- Re: Docstring of `decode-coding-string' a bit misleading about insertion in buffer, Kenichi Handa, 2008/10/21
- Re: Docstring of `decode-coding-string' a bit misleading about insertion in buffer,
Richard M. Stallman <=
- Re: Docstring of `decode-coding-string' a bit misleading about insertion in buffer, Kenichi Handa, 2008/10/20
- Re: Docstring of `decode-coding-string' a bit misleading about insertion in buffer, Richard M. Stallman, 2008/10/21
- Re: Docstring of `decode-coding-string' a bit misleading about insertion in buffer, Richard M. Stallman, 2008/10/20