From: Fred Drake <fdrake@acm.org>
Date: Thu, 12 Jul 2001 02:08:29 +0000 (+0000)
Subject: For \kbd, be more prescriptive regarding how keystrokes should be
X-Git-Tag: v2.2a3~1265
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=07178d237ac180a9daa48af2a4c7b5b00d07dcfc;p=thirdparty%2FPython%2Fcpython.git

For \kbd, be more prescriptive regarding how keystrokes should be
written.
---

diff --git a/Doc/doc/doc.tex b/Doc/doc/doc.tex
index 7069f2f6d6c4..9254ebb57a3b 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}}