diff options
| author | Paul Eggert | 2017-11-25 22:55:35 -0800 |
|---|---|---|
| committer | Paul Eggert | 2017-11-25 22:55:35 -0800 |
| commit | d20161b25e9cd184d841ba9e36ee5141c01fd75f (patch) | |
| tree | 6026fea9d48e641bf63b23209970efd1f8024e2c /admin/notes/documentation | |
| parent | e27004c5fe3c227476ea210ff5bee2efb783ae17 (diff) | |
| parent | a89f0b6f33f9eb8910a1fceda9028d76ef50b05d (diff) | |
| download | emacs-d20161b25e9cd184d841ba9e36ee5141c01fd75f.tar.gz emacs-d20161b25e9cd184d841ba9e36ee5141c01fd75f.zip | |
Merge from origin/emacs-26
a89f0b6f33 maint: shorten https://lists.gnu.org/archive/html/... links
8be3aee281 Merge from Gnulib
265cee553f Work around GCC bug 80776 on Fedora 27 x86
dc7a97fb84 Tweak copy-file, rename-file doc
cfa2a944d4 Change font-lock-extend-region-multiline handling in mhtml...
a8664cc998 Minor cleanup in tramp-gvfs-handle-file-local-copy
55c5b12fa0 Add test for Bug#29423 in Tramp.
3198a1646e Avoid jumbled order in HTML rendered by shr.el
23bfc2d2db Make sure 'dired-filename' property is always put by ls-lisp
f7fdaea4c0 A better solution for bug#29347
86e6ed8521 ; * src/thread.c (acquire_global_lock): Fix thinko in last...
f300852037 Avoid a hang after C-g while sit-for on a Unix TTY
d7fc719ff1 Improve the doc string of 'list-packages'
b4f67ebb92 Improve discoverability of 'defvar' for suppressing warnings
8a2b204e64 Improve discoverability of 'read-buffer-completion-ignore-...
eea4e9194c Improve documentation of self-insert-uses-region-functions
e6e41dac87 Reflect changes in copy-file and rename-file in doc strings
0ec534070f * lisp/progmodes/cc-vars.el (c-offsets-alist): Doc fix. (...
1d0dbdff6c Reorder type predicates in ELisp manual
b081ec9dd7 Fix backward scrolling in buffers with header-line
8e40429c96 ; Fix some doc typos
ed2c542920 * lisp/bindings.el (buffer-file-coding-system): Add explic...
d82474e452 * src/fns.c (syms_of_fns) <overriding-plist-environment>: ...
292c09ff6d Fix incorrect interaction of drag/drop and double click (b...
d6fadb1d26 * lisp/menu-bar.el (menu-bar-options-save): Add display-li...
daa959efbc * lisp/menu-bar.el (menu-bar-options-save): Add global-dis...
17fc74d1b9 * lisp/follow.el (follow-mode): Restore mode line lighter....
f20c2e2f3d ; Compare process status against 127 exactly
2d203ffb7e Extract the common part of ruby-flymake-simple and ruby-fl...
09944d499a Add Rubocop Flymake backend
c65a0ae7c4 ; Fix a typo
7ab7603125 Update nt/INSTALL.W64 (Bug#28601)
11db253c08 Remove incorrect NEWS item about VC state indicator (Bug#2...
2fdc01c036 * lisp/emacs-lisp/byte-run.el (defsubst): Doc fix.
735c8b516e Make c-defun-name analyze more thoroughly a function type ...
92f0c4cd56 Avoid bogus abbreviated file names if HOME changes
8d450453fa * lisp/emacs-lisp/byte-run.el (inline): Give it a doc.
37a3b4ea40 Fix erc keep-place module with new defaults (Bug#29111)
6c312605bf Add window divider faces to NS (bug#29353)
# Conflicts:
# etc/NEWS
# lisp/ruler-mode.el
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 |