summaryrefslogtreecommitdiffstats
path: root/Doc/doc
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>2001-07-12 02:08:29 (GMT)
committerFred Drake <fdrake@acm.org>2001-07-12 02:08:29 (GMT)
commit07178d237ac180a9daa48af2a4c7b5b00d07dcfc (patch)
treecb6cb9818027e51758811e943f3c604b7d09d099 /Doc/doc
parente38b2f1f00f46e24eaf83182799f4f515ffb410d (diff)
downloadcpython-07178d237ac180a9daa48af2a4c7b5b00d07dcfc.zip
cpython-07178d237ac180a9daa48af2a4c7b5b00d07dcfc.tar.gz
cpython-07178d237ac180a9daa48af2a4c7b5b00d07dcfc.tar.bz2
For \kbd, be more prescriptive regarding how keystrokes should be
written.
Diffstat (limited to 'Doc/doc')
-rw-r--r--Doc/doc/doc.tex9
1 files changed, 7 insertions, 2 deletions
diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index 7069f2f..9254ebb 100644
--- a/Doc/doc/doc.tex
+++ b/Doc/doc/doc.tex
@@ -787,8 +787,13 @@ This \UNIX\ is also followed by a space.
\begin{macrodesc}{kbd}{\p{key sequence}}
Mark a sequence of keystrokes. What form \var{key sequence}
takes may depend on platform- or application-specific
- conventions. For example, an \program{xemacs} key sequence
- may be marked like \code{\e kbd\{C-x C-f\}}.
+ conventions. When there are no relevant conventions, the names
+ of modifier keys should be spelled out, to improve accessibility
+ for new users and non-native speakers. For example, an
+ \program{xemacs} key sequence may be marked like
+ \code{\e kbd\{C-x C-f\}}, but without reference to a specific
+ application or platform, the same sequence should be marked as
+ \code{\e kbd\{Control-x Control-f\}}.
\end{macrodesc}
\begin{macrodesc}{keyword}{\p{name}}