]> granicus.if.org Git - python/commitdiff
Marked keystrokes with the :kbd: role.
authorSerhiy Storchaka <storchaka@gmail.com>
Sat, 12 Sep 2015 14:45:25 +0000 (17:45 +0300)
committerSerhiy Storchaka <storchaka@gmail.com>
Sat, 12 Sep 2015 14:45:25 +0000 (17:45 +0300)
Fixed the case of the "Ctrl-" prefixes.

19 files changed:
Doc/faq/extending.rst
Doc/faq/windows.rst
Doc/library/asyncio-eventloop.rst
Doc/library/asyncio-protocol.rst
Doc/library/asyncio-stream.rst
Doc/library/idle.rst
Doc/library/multiprocessing.rst
Doc/library/pdb.rst
Doc/library/signal.rst
Doc/library/tkinter.ttk.rst
Doc/library/unittest.rst
Doc/tutorial/appendix.rst
Doc/tutorial/interpreter.rst
Doc/using/cmdline.rst
Doc/whatsnew/2.0.rst
Doc/whatsnew/2.5.rst
Doc/whatsnew/2.7.rst
Lib/test/test_os.py
Lib/unittest/main.py

index fea5a57601250f8f389fdd327d4a5cdfec0fd3fc..ae0d905ec46594b0a5cb0f03d19d1e8e9ee4beb2 100644 (file)
@@ -348,7 +348,7 @@ complete example using the GNU readline library (you may want to ignore
      {
        line = readline (prompt);
 
-       if (NULL == line)                          /* CTRL-D pressed */
+       if (NULL == line)                          /* Ctrl-D pressed */
        {
          done = 1;
        }
index 7cac8a9739de9e37d72158bc443af5315c4dd3e7..6db6637ed78d500cc9497e1e4d925faf2ed61eea 100644 (file)
@@ -81,14 +81,14 @@ by entering a few expressions of your choice and seeing the results::
     'HelloHelloHello'
 
 Many people use the interactive mode as a convenient yet highly programmable
-calculator.  When you want to end your interactive Python session, hold the Ctrl
-key down while you enter a Z, then hit the "Enter" key to get back to your
+calculator.  When you want to end your interactive Python session, hold the :kbd:`Ctrl`
+key down while you enter a :kbd:`Z`, then hit the ":kbd:`Enter`" key to get back to your
 Windows command prompt.
 
 You may also find that you have a Start-menu entry such as :menuselection:`Start
 --> Programs --> Python 3.3 --> Python (command line)` that results in you
 seeing the ``>>>`` prompt in a new window.  If so, the window will disappear
-after you enter the Ctrl-Z character; Windows is running a single "python"
+after you enter the :kbd:`Ctrl-Z` character; Windows is running a single "python"
 command in the window, and closes it when you terminate the interpreter.
 
 If the ``python`` command, instead of displaying the interpreter prompt ``>>>``,
@@ -131,8 +131,8 @@ you should make sure that entering the command ::
 
    c:\Python33\python
 
-starts up the interpreter as above (and don't forget you'll need a "CTRL-Z" and
-an "Enter" to get out of it). Once you have verified the directory, you can
+starts up the interpreter as above (and don't forget you'll need a ":kbd:`Ctrl-Z`" and
+an ":kbd:`Enter`" to get out of it). Once you have verified the directory, you can
 add it to the system path to make it easier to start Python by just running
 the ``python`` command. This is currently an option in the installer as of
 CPython 3.3.
@@ -327,7 +327,7 @@ Prior to Python 2.7 and 3.2, to terminate a process, you can use :mod:`ctypes`::
        return (0 != kernel32.TerminateProcess(handle, 0))
 
 In 2.7 and 3.2, :func:`os.kill` is implemented similar to the above function,
-with the additional feature of being able to send CTRL+C and CTRL+BREAK
+with the additional feature of being able to send :kbd:`Ctrl+C` and :kbd:`Ctrl+Break`
 to console subprocesses which are designed to handle those signals. See
 :func:`os.kill` for further details.
 
index dee3286d0faa12768aa214b51c34ade395f91095..277e4045df3d9c268b6bb482c728bdda1312853b 100644 (file)
@@ -853,7 +853,7 @@ the :meth:`BaseEventLoop.add_signal_handler` method::
         loop.add_signal_handler(getattr(signal, signame),
                                 functools.partial(ask_exit, signame))
 
-    print("Event loop running forever, press CTRL+c to interrupt.")
+    print("Event loop running forever, press Ctrl+C to interrupt.")
     print("pid %s: send SIGINT or SIGTERM to exit." % os.getpid())
     try:
         loop.run_forever()
index 2e671e89a285b2b879cb64268e9d7a2c1bc61b0c..02a1b68c536a2d289df2ce0bb47a898a3f0cdf35 100644 (file)
@@ -539,7 +539,7 @@ received data and close the connection::
     coro = loop.create_server(EchoServerClientProtocol, '127.0.0.1', 8888)
     server = loop.run_until_complete(coro)
 
-    # Serve requests until CTRL+c is pressed
+    # Serve requests until Ctrl+C is pressed
     print('Serving on {}'.format(server.sockets[0].getsockname()))
     try:
         loop.run_forever()
index e9638e362879da9f09307515c6ccfab8989544f0..0ba3d708e61e3bf537bd1da2cc92f8e80ad7010e 100644 (file)
@@ -312,7 +312,7 @@ TCP echo server using the :func:`asyncio.start_server` function::
     coro = asyncio.start_server(handle_echo, '127.0.0.1', 8888, loop=loop)
     server = loop.run_until_complete(coro)
 
-    # Serve requests until CTRL+c is pressed
+    # Serve requests until Ctrl+C is pressed
     print('Serving on {}'.format(server.sockets[0].getsockname()))
     try:
         loop.run_forever()
index e64f6831d92ae5ffaf967e1376c166db52dc03c1..ecc71156c9fb0935c45eb379dfbe15a2fbcd9256 100644 (file)
@@ -330,8 +330,8 @@ Go to file/line
 Editing and navigation
 ----------------------
 
-In this section, 'C' refers to the Control key on Windows and Unix and
-the Command key on Mac OSX.
+In this section, 'C' refers to the :kbd:`Control` key on Windows and Unix and
+the :kbd:`Command` key on Mac OSX.
 
 * :kbd:`Backspace` deletes to the left; :kbd:`Del` deletes to the right
 
index 4d5f30841e4af67b643d622fb7a0d0d7ad547e9a..93f59cdbf6c298b36b366ecefa45e262a0149968 100644 (file)
@@ -1174,7 +1174,7 @@ object -- see :ref:`multiprocessing-managers`.
 
 .. note::
 
-   If the SIGINT signal generated by Ctrl-C arrives while the main thread is
+   If the SIGINT signal generated by :kbd:`Ctrl-C` arrives while the main thread is
    blocked by a call to :meth:`BoundedSemaphore.acquire`, :meth:`Lock.acquire`,
    :meth:`RLock.acquire`, :meth:`Semaphore.acquire`, :meth:`Condition.acquire`
    or :meth:`Condition.wait` then the call will be immediately interrupted and
index 6e526f4302d96c0e14a76ea095ca0d02676cba59..c144db6c1aca461da976d5e5df606d5f94654074 100644 (file)
@@ -156,8 +156,8 @@ access further features, you have to do this yourself:
    that matches one of these patterns. [1]_
 
    By default, Pdb sets a handler for the SIGINT signal (which is sent when the
-   user presses Ctrl-C on the console) when you give a ``continue`` command.
-   This allows you to break into the debugger again by pressing Ctrl-C.  If you
+   user presses :kbd:`Ctrl-C` on the console) when you give a ``continue`` command.
+   This allows you to break into the debugger again by pressing :kbd:`Ctrl-C`.  If you
    want Pdb not to touch the SIGINT handler, set *nosigint* tot true.
 
    Example call to enable tracing with *skip*::
index 84e283683d07fcd1cf3c214a9284fee3cd05e28f..8b90994846928e3dd9b5339f22b89a26a62b5212 100644 (file)
@@ -95,7 +95,7 @@ The variables defined in the :mod:`signal` module are:
 
 .. data:: CTRL_C_EVENT
 
-   The signal corresponding to the CTRL+C keystroke event. This signal can
+   The signal corresponding to the :kbd:`Ctrl+C` keystroke event. This signal can
    only be used with :func:`os.kill`.
 
    Availability: Windows.
@@ -105,7 +105,7 @@ The variables defined in the :mod:`signal` module are:
 
 .. data:: CTRL_BREAK_EVENT
 
-   The signal corresponding to the CTRL+BREAK keystroke event. This signal can
+   The signal corresponding to the :kbd:`Ctrl+Break` keystroke event. This signal can
    only be used with :func:`os.kill`.
 
    Availability: Windows.
index b0eefcb7024f53ed90fb2ac65c6e24acd52b6798..ab8a9a99e7d30d5653711fd2c4cee44c4047bef7 100644 (file)
@@ -554,9 +554,9 @@ ttk.Notebook
       This will extend the bindings for the toplevel window containing the
       notebook as follows:
 
-      * Control-Tab: selects the tab following the currently selected one.
-      * Shift-Control-Tab: selects the tab preceding the currently selected one.
-      * Alt-K: where K is the mnemonic (underlined) character of any tab, will
+      * :kbd:`Control-Tab`: selects the tab following the currently selected one.
+      * :kbd:`Shift-Control-Tab`: selects the tab preceding the currently selected one.
+      * :kbd:`Alt-K`: where *K* is the mnemonic (underlined) character of any tab, will
         select that tab.
 
       Multiple notebooks in a single toplevel may be enabled for traversal,
index a8a684cf3b2086c7b3e7e1fad592f55d0c68e07e..1930f785a772776e82e373dd0afc9c2a50c01508 100644 (file)
@@ -204,8 +204,8 @@ Command-line options
 
 .. cmdoption:: -c, --catch
 
-   Control-C during the test run waits for the current test to end and then
-   reports all the results so far. A second control-C raises the normal
+   :kbd:`Control-C` during the test run waits for the current test to end and then
+   reports all the results so far. A second :kbd:`Control-C` raises the normal
    :exc:`KeyboardInterrupt` exception.
 
    See `Signal Handling`_ for the functions that provide this functionality.
index 8670efc8e9be3ac50311408d281000ac37648ca8..ce50c1e8c3360e24be5c4e729875fdd41534ce1f 100644 (file)
@@ -25,7 +25,7 @@ some cases of running out of memory.  All error messages are written to the
 standard error stream; normal output from executed commands is written to
 standard output.
 
-Typing the interrupt character (usually Control-C or DEL) to the primary or
+Typing the interrupt character (usually :kbd:`Control-C` or :kbd:`Delete`) to the primary or
 secondary prompt cancels the input and returns to the primary prompt. [#]_
 Typing an interrupt while a command is executing raises the
 :exc:`KeyboardInterrupt` exception, which may be handled by a :keyword:`try`
index 80516349c79e941b141d905c2951f5891d363061..dd6b1a9f3837dc5ccb52849d532c5e1bddb5423e 100644 (file)
@@ -38,7 +38,7 @@ following command: ``quit()``.
 The interpreter's line-editing features include interactive editing, history
 substitution and code completion on systems that support readline.  Perhaps the
 quickest check to see whether command line editing is supported is typing
-Control-P to the first Python prompt you get.  If it beeps, you have command
+:kbd:`Control-P` to the first Python prompt you get.  If it beeps, you have command
 line editing; see Appendix :ref:`tut-interacting` for an introduction to the
 keys.  If nothing appears to happen, or if ``^P`` is echoed, command line
 editing isn't available; you'll only be able to use backspace to remove
index 4017ce897c6bb52c341bc520296fb2c844c67b95..a46349bcde0c42be865abe32fbebbe84bba78095 100644 (file)
@@ -41,7 +41,7 @@ additional methods of invocation:
 
 * When called with standard input connected to a tty device, it prompts for
   commands and executes them until an EOF (an end-of-file character, you can
-  produce that with *Ctrl-D* on UNIX or *Ctrl-Z, Enter* on Windows) is read.
+  produce that with :kbd:`Ctrl-D` on UNIX or :kbd:`Ctrl-Z, Enter` on Windows) is read.
 * When called with a file name argument or with a file as standard input, it
   reads and executes a script from that file.
 * When called with a directory name argument, it reads and executes an
index 2c952acd119d3e87ac1ba498deb248e08b60270e..10bb29ee8a0e603d6f43d60d10d395928238dbf3 100644 (file)
@@ -1174,8 +1174,8 @@ partial list:
 
 * In the editor window, there is now a line/column bar at the bottom.
 
-* Three new keystroke commands: Check module (Alt-F5), Import module (F5) and
-  Run script (Ctrl-F5).
+* Three new keystroke commands: Check module (:kbd:`Alt-F5`), Import module (:kbd:`F5`) and
+  Run script (:kbd:`Ctrl-F5`).
 
 .. ======================================================================
 
index f8f7ca04a909346242b3c988584cab8abac9801d..cb92e08d6f840d7da411dd775964020a86908762 100644 (file)
@@ -827,7 +827,7 @@ inheritance relationships are::
 This rearrangement was done because people often want to catch all exceptions
 that indicate program errors.  :exc:`KeyboardInterrupt` and :exc:`SystemExit`
 aren't errors, though, and usually represent an explicit action such as the user
-hitting Control-C or code calling :func:`sys.exit`.  A bare ``except:`` will
+hitting :kbd:`Control-C` or code calling :func:`sys.exit`.  A bare ``except:`` will
 catch all exceptions, so you commonly need to list :exc:`KeyboardInterrupt` and
 :exc:`SystemExit` in order to re-raise them.  The usual pattern is::
 
index ed1446c2570548719e6949f7df0d2f6577b11130..fb0551e1add807084723a51863bdbd105f2bba90 100644 (file)
@@ -2320,7 +2320,7 @@ Port-Specific Changes: Windows
 * The :func:`os.kill` function now works on Windows.  The signal value
   can be the constants :const:`CTRL_C_EVENT`,
   :const:`CTRL_BREAK_EVENT`, or any integer.  The first two constants
-  will send Control-C and Control-Break keystroke events to
+  will send :kbd:`Control-C` and :kbd:`Control-Break` keystroke events to
   subprocesses; any other value will use the :c:func:`TerminateProcess`
   API.  (Contributed by Miki Tebeka; :issue:`1220212`.)
 
index 0bbf73dca4ca6c648d295a85c4074f3cbba02551..54dd9da2a4e65bd9aea2fdb185250202476252a6 100644 (file)
@@ -1657,7 +1657,7 @@ class Win32KillTests(unittest.TestCase):
             os.kill(proc.pid, signal.SIGINT)
             self.fail("subprocess did not stop on {}".format(name))
 
-    @unittest.skip("subprocesses aren't inheriting CTRL+C property")
+    @unittest.skip("subprocesses aren't inheriting Ctrl+C property")
     def test_CTRL_C_EVENT(self):
         from ctypes import wintypes
         import ctypes
@@ -1670,7 +1670,7 @@ class Win32KillTests(unittest.TestCase):
         SetConsoleCtrlHandler.restype = wintypes.BOOL
 
         # Calling this with NULL and FALSE causes the calling process to
-        # handle CTRL+C, rather than ignore it. This property is inherited
+        # handle Ctrl+C, rather than ignore it. This property is inherited
         # by subprocesses.
         SetConsoleCtrlHandler(NULL, 0)
 
index 180df8676e5f17e1f942a3ae7c0fee8cc5fcef32..e750ca5062224b4a2f8409e741a980eb566e4478 100644 (file)
@@ -168,7 +168,7 @@ class TestProgram(object):
         if self.catchbreak is None:
             parser.add_argument('-c', '--catch', dest='catchbreak',
                                 action='store_true',
-                                help='Catch ctrl-C and display results so far')
+                                help='Catch Ctrl-C and display results so far')
             self.catchbreak = False
         if self.buffer is None:
             parser.add_argument('-b', '--buffer', dest='buffer',