aboutsummaryrefslogtreecommitdiffstats
path: root/admin/notes/documentation
diff options
context:
space:
mode:
authorPaul Eggert2017-10-01 21:58:52 -0700
committerPaul Eggert2017-10-01 21:58:52 -0700
commit4829a3b033b119b088947d14b73efc197b2547fa (patch)
treeef9a96d2fa02c559ce69ff3ac9a272af84e5f6e9 /admin/notes/documentation
parentee3024c70d2974b59ecdd04b75d18d7258262e70 (diff)
parent5172fa02cccaab2500ecf85aaf65b8deed54d42e (diff)
downloademacs-4829a3b033b119b088947d14b73efc197b2547fa.tar.gz
emacs-4829a3b033b119b088947d14b73efc197b2547fa.zip
Merge from origin/emacs-26
5172fa02cc Prefer HTTPS to HTTP for gnu.org 8cdd8b920a Merge from Gnulib 60b7668b89 Keep eww buffer current when looking up CSS on MDN bd49b6f1b3 Workaround for faulty localtime() under macOS 10.6 913808e224 Doc amendment for syntax-ppss. 98dc91fda8 Remove incorrect NEWS entry about 'find-library' 539d8626cd Remove inadvertent changes to syntax.texi in last commit. 8c18dcbc78 Amend documentation for text-quoting-style becoming a user... 5f76ac150a Make the value nil in text-quoting-style mean what it does... d5e4e004fa Make text-quoting-style customizable. Introduce t and new... 1ba3471b9b eshell.texi improvements 7abb5c3960 Fix ns-win.el on GNUstep 07ea5ef99a Fix reference style in org.texi b03b4f6d79 Improve handling of iconification of child frames (Bug#28611) ba9139c501 Revert "Don't lose arguments to eshell aliases (Bug#27954)" 43fac3beae Make "unsafe directory" error message more informative (Bu... c59ddb2120 Fix slot typecheck in eieio-persistent 8b2ab5014b Fix semantic-ia-fast-jump 5b45e7e1c3 Bind vc-region-history f172894595 Exit macro definition on undefined keys 289fe6c0d1 Reset bidi-paragraph-direction on article rendering a4f7518817 Fix url-http use of url-current-object 4a755ed421 Avoid assertions in vc-hg.el on MS-Windows cb93a6ce72 Improve documentation of 'copy-sequence' 200ef6f721 Minor update of ack.texi cb407d3e87 * doc/emacs/emacs.texi (Acknowledgments): Add more contrib... 82b6c765ff Improve indexing of multi-file/buffer Isearch commands 645ff6c702 Add CAM02 JCh and CAM02-UCS J'a'b' conversions 157007b58e Fix uses of @kindex in the Emacs manual 63a45e8837 Merge branch 'emacs-26' of git.savannah.gnu.org:/srv/git/e... 3ab2f9bbb9 Merge from gnulib cbc8324488 Prefer HTTPS to HTTP for gnu.org bbda601d1d ; Spelling fixes 695cf5300b Wait for frame visibility with timeout in w32term too e1f6e3127a Bring back the busy wait after x_make_frame_visible (Bug#2... bccf635217 ; * src/gtkutil.c (xg_check_special_colors): Add another G... f428757cdb Merge branch 'emacs-26' of git.savannah.gnu.org:/srv/git/e... 26d58f0c58 ; Standardize license notices 73dba0f466 Fix last doc string change in simple.el
Diffstat (limited to 'admin/notes/documentation')
-rw-r--r--admin/notes/documentation12
1 files changed, 6 insertions, 6 deletions
diff --git a/admin/notes/documentation b/admin/notes/documentation
index 09476ad6962..fc9c720bd08 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
8http://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00400.html 8https://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00400.html
9 9
10For example, this text: 10For 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
54http://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00414.html 54https://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00414.html
55 55
56In Emacs tradition, we treat "point" as a proper name when it refers 56In Emacs tradition, we treat "point" as a proper name when it refers
57to the current editing location. It should not have an article. 57to 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
68http://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00414.html 68https://lists.gnu.org/archive/html/emacs-devel/2008-10/msg00414.html
69 69
70Documentation is clearer if it avoids the passive voice whenever 70Documentation is clearer if it avoids the passive voice whenever
71possible. For example, rather than saying "Point does not move", say 71possible. 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
83http://lists.gnu.org/archive/html/emacs-devel/2008-11/msg00893.html 83https://lists.gnu.org/archive/html/emacs-devel/2008-11/msg00893.html
84 84
85The usefulness of Antinews is to help people who buy the printed 85The usefulness of Antinews is to help people who buy the printed
86manual and are still using the previous Emacs version. That's why we 86manual 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
94http://lists.gnu.org/archive/html/emacs-devel/2008-11/msg01054.html 94https://lists.gnu.org/archive/html/emacs-devel/2008-11/msg01054.html
95 95
96Since the purpose of Antinews is to help people use the previous Emacs 96Since the purpose of Antinews is to help people use the previous Emacs
97version, there is usually no need to mention features that are simply 97version, 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
114the old version without some sort of help. 114the 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'.
117http://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00649.html 117https://lists.gnu.org/archive/html/emacs-devel/2012-02/msg00649.html