diff options
| author | Paul Eggert | 2017-11-25 22:45:41 -0800 |
|---|---|---|
| committer | Paul Eggert | 2017-11-25 22:48:12 -0800 |
| commit | a89f0b6f33f9eb8910a1fceda9028d76ef50b05d (patch) | |
| tree | 7055882872b7cad587e5d5e9ac706056f04ff777 /admin/notes/documentation | |
| parent | 8be3aee2813f528b02bc913ca4d79e34e72b1754 (diff) | |
| download | emacs-a89f0b6f33f9eb8910a1fceda9028d76ef50b05d.tar.gz emacs-a89f0b6f33f9eb8910a1fceda9028d76ef50b05d.zip | |
maint: shorten https://lists.gnu.org/archive/html/... links
Diffstat (limited to 'admin/notes/documentation')
| -rw-r--r-- | admin/notes/documentation | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/admin/notes/documentation b/admin/notes/documentation index fc9c720bd08..d894175e212 100644 --- a/admin/notes/documentation +++ b/admin/notes/documentation | |||
| @@ -5,7 +5,7 @@ Some documentation tips culled from emacs-devel postings. | |||
| 5 | 5 | ||
| 6 | ** Manual indices | 6 | ** Manual indices |
| 7 | 7 | ||
| 8 | https://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00400.html | 8 | https://lists.gnu.org/r/emacs-devel/2008-10/msg00400.html |
| 9 | 9 | ||
| 10 | For example, this text: | 10 | For example, this text: |
| 11 | 11 | ||
| @@ -51,7 +51,7 @@ combine them into a single entry, e.g.: | |||
| 51 | 51 | ||
| 52 | ** Point is a proper name | 52 | ** Point is a proper name |
| 53 | 53 | ||
| 54 | https://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00414.html | 54 | https://lists.gnu.org/r/emacs-devel/2008-10/msg00414.html |
| 55 | 55 | ||
| 56 | In Emacs tradition, we treat "point" as a proper name when it refers | 56 | In Emacs tradition, we treat "point" as a proper name when it refers |
| 57 | to the current editing location. It should not have an article. | 57 | to the current editing location. It should not have an article. |
| @@ -65,7 +65,7 @@ referring to point, please fix it. | |||
| 65 | 65 | ||
| 66 | ** Don't use passive verbs | 66 | ** Don't use passive verbs |
| 67 | 67 | ||
| 68 | https://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00414.html | 68 | https://lists.gnu.org/r/emacs-devel/2008-10/msg00414.html |
| 69 | 69 | ||
| 70 | Documentation is clearer if it avoids the passive voice whenever | 70 | Documentation is clearer if it avoids the passive voice whenever |
| 71 | possible. For example, rather than saying "Point does not move", say | 71 | possible. For example, rather than saying "Point does not move", say |
| @@ -80,7 +80,7 @@ often provides important information which makes the text clearer, too. | |||
| 80 | 80 | ||
| 81 | *** Why Antinews is useful | 81 | *** Why Antinews is useful |
| 82 | 82 | ||
| 83 | https://lists.gnu.org/archive/html/emacs-devel/2008-11/msg00893.html | 83 | https://lists.gnu.org/r/emacs-devel/2008-11/msg00893.html |
| 84 | 84 | ||
| 85 | The usefulness of Antinews is to help people who buy the printed | 85 | The usefulness of Antinews is to help people who buy the printed |
| 86 | manual and are still using the previous Emacs version. That's why we | 86 | manual and are still using the previous Emacs version. That's why we |
| @@ -91,7 +91,7 @@ Of course, we try to make it amusing as well. | |||
| 91 | 91 | ||
| 92 | *** Don't mention in Antinews too many features absent in old versions | 92 | *** Don't mention in Antinews too many features absent in old versions |
| 93 | 93 | ||
| 94 | https://lists.gnu.org/archive/html/emacs-devel/2008-11/msg01054.html | 94 | https://lists.gnu.org/r/emacs-devel/2008-11/msg01054.html |
| 95 | 95 | ||
| 96 | Since the purpose of Antinews is to help people use the previous Emacs | 96 | Since the purpose of Antinews is to help people use the previous Emacs |
| 97 | version, there is usually no need to mention features that are simply | 97 | version, there is usually no need to mention features that are simply |
| @@ -114,4 +114,4 @@ In those cases, the user might have trouble figuring out how to use | |||
| 114 | the old version without some sort of help. | 114 | the old version without some sort of help. |
| 115 | 115 | ||
| 116 | ** To indicate possession, write Emacs's rather than Emacs'. | 116 | ** To indicate possession, write Emacs's rather than Emacs'. |
| 117 | https://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00649.html | 117 | https://lists.gnu.org/r/emacs-devel/2012-02/msg00649.html |