From 0424eaf7533b0f386f6038dbb99f89e30fbbff76 Mon Sep 17 00:00:00 2001 From: Serhiy Storchaka Date: Sat, 12 Sep 2015 17:45:25 +0300 Subject: Marked keystrokes with the :kbd: role. Fixed the case of the "Ctrl-" prefixes. --- Doc/faq/extending.rst | 2 +- Doc/faq/windows.rst | 12 ++++++------ Doc/library/asyncio-eventloop.rst | 2 +- Doc/library/asyncio-protocol.rst | 2 +- Doc/library/asyncio-stream.rst | 2 +- Doc/library/idle.rst | 4 ++-- Doc/library/multiprocessing.rst | 2 +- Doc/library/pdb.rst | 4 ++-- Doc/library/signal.rst | 4 ++-- Doc/library/tkinter.ttk.rst | 6 +++--- Doc/library/unittest.rst | 4 ++-- Doc/tutorial/appendix.rst | 2 +- Doc/tutorial/interpreter.rst | 2 +- Doc/using/cmdline.rst | 2 +- Doc/whatsnew/2.0.rst | 4 ++-- Doc/whatsnew/2.5.rst | 2 +- Doc/whatsnew/2.7.rst | 2 +- Lib/test/test_os.py | 4 ++-- Lib/unittest/main.py | 2 +- 19 files changed, 32 insertions(+), 32 deletions(-) diff --git a/Doc/faq/extending.rst b/Doc/faq/extending.rst index fea5a57..ae0d905 100644 --- a/Doc/faq/extending.rst +++ b/Doc/faq/extending.rst @@ -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; } diff --git a/Doc/faq/windows.rst b/Doc/faq/windows.rst index 7cac8a9..6db6637 100644 --- a/Doc/faq/windows.rst +++ b/Doc/faq/windows.rst @@ -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. diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst index dee3286..277e404 100644 --- a/Doc/library/asyncio-eventloop.rst +++ b/Doc/library/asyncio-eventloop.rst @@ -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() diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst index 2e671e8..02a1b68 100644 --- a/Doc/library/asyncio-protocol.rst +++ b/Doc/library/asyncio-protocol.rst @@ -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() diff --git a/Doc/library/asyncio-stream.rst b/Doc/library/asyncio-stream.rst index e9638e3..0ba3d70 100644 --- a/Doc/library/asyncio-stream.rst +++ b/Doc/library/asyncio-stream.rst @@ -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() diff --git a/Doc/library/idle.rst b/Doc/library/idle.rst index e64f683..ecc7115 100644 --- a/Doc/library/idle.rst +++ b/Doc/library/idle.rst @@ -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 diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index 4d5f308..93f59cd 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -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 diff --git a/Doc/library/pdb.rst b/Doc/library/pdb.rst index 6e526f4..c144db6 100644 --- a/Doc/library/pdb.rst +++ b/Doc/library/pdb.rst @@ -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*:: diff --git a/Doc/library/signal.rst b/Doc/library/signal.rst index 84e2836..8b90994 100644 --- a/Doc/library/signal.rst +++ b/Doc/library/signal.rst @@ -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. diff --git a/Doc/library/tkinter.ttk.rst b/Doc/library/tkinter.ttk.rst index b0eefcb..ab8a9a9 100644 --- a/Doc/library/tkinter.ttk.rst +++ b/Doc/library/tkinter.ttk.rst @@ -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, diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst index a8a684c..1930f78 100644 --- a/Doc/library/unittest.rst +++ b/Doc/library/unittest.rst @@ -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. diff --git a/Doc/tutorial/appendix.rst b/Doc/tutorial/appendix.rst index 8670efc..ce50c1e 100644 --- a/Doc/tutorial/appendix.rst +++ b/Doc/tutorial/appendix.rst @@ -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` diff --git a/Doc/tutorial/interpreter.rst b/Doc/tutorial/interpreter.rst index 8051634..dd6b1a9 100644 --- a/Doc/tutorial/interpreter.rst +++ b/Doc/tutorial/interpreter.rst @@ -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 diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index 4017ce8..a46349b 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -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 diff --git a/Doc/whatsnew/2.0.rst b/Doc/whatsnew/2.0.rst index 2c952ac..10bb29e 100644 --- a/Doc/whatsnew/2.0.rst +++ b/Doc/whatsnew/2.0.rst @@ -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`). .. ====================================================================== diff --git a/Doc/whatsnew/2.5.rst b/Doc/whatsnew/2.5.rst index f8f7ca0..cb92e08 100644 --- a/Doc/whatsnew/2.5.rst +++ b/Doc/whatsnew/2.5.rst @@ -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:: diff --git a/Doc/whatsnew/2.7.rst b/Doc/whatsnew/2.7.rst index ed1446c..fb0551e 100644 --- a/Doc/whatsnew/2.7.rst +++ b/Doc/whatsnew/2.7.rst @@ -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`.) diff --git a/Lib/test/test_os.py b/Lib/test/test_os.py index 0bbf73d..54dd9da2 100644 --- a/Lib/test/test_os.py +++ b/Lib/test/test_os.py @@ -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) diff --git a/Lib/unittest/main.py b/Lib/unittest/main.py index 180df86..e750ca5 100644 --- a/Lib/unittest/main.py +++ b/Lib/unittest/main.py @@ -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', -- cgit v0.12