]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
For \kbd, be more prescriptive regarding how keystrokes should be
authorFred Drake <fdrake@acm.org>
Thu, 12 Jul 2001 02:08:29 +0000 (02:08 +0000)
committerFred Drake <fdrake@acm.org>
Thu, 12 Jul 2001 02:08:29 +0000 (02:08 +0000)
written.

Doc/doc/doc.tex

index 7069f2f6d6c410c868eb95f29303c90ddea2382c..9254ebb57a3b71eb39d68b73472f554a5e40d4b0 100644 (file)
@@ -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}}