summaryrefslogtreecommitdiffstats
path: root/Lib/cmd.py
diff options
context:
space:
mode:
authorGeoffrey Thomas <geofft@ldpreload.com>2024-05-22 16:35:18 (GMT)
committerGitHub <noreply@github.com>2024-05-22 16:35:18 (GMT)
commitef172521a9e9dfadebe57d590bfb53a0e9ac3a0b (patch)
tree22da7f25285e842c48daf81b0ae2a57e223cc674 /Lib/cmd.py
parent81865002aee8eaaeb3c7e402f86183afa6de77bf (diff)
downloadcpython-ef172521a9e9dfadebe57d590bfb53a0e9ac3a0b.zip
cpython-ef172521a9e9dfadebe57d590bfb53a0e9ac3a0b.tar.gz
cpython-ef172521a9e9dfadebe57d590bfb53a0e9ac3a0b.tar.bz2
Remove almost all unpaired backticks in docstrings (#119231)
As reported in #117847 and #115366, an unpaired backtick in a docstring tends to confuse e.g. Sphinx running on subclasses of standard library objects, and the typographic style of using a backtick as an opening quote is no longer in favor. Convert almost all uses of the form The variable `foo' should do xyz to The variable 'foo' should do xyz and also fix up miscellaneous other unpaired backticks (extraneous / missing characters). No functional change is intended here other than in human-readable docstrings.
Diffstat (limited to 'Lib/cmd.py')
-rw-r--r--Lib/cmd.py24
1 files changed, 12 insertions, 12 deletions
diff --git a/Lib/cmd.py b/Lib/cmd.py
index a37d16c..c333e09 100644
--- a/Lib/cmd.py
+++ b/Lib/cmd.py
@@ -5,16 +5,16 @@ Interpreters constructed with this class obey the following conventions:
1. End of file on input is processed as the command 'EOF'.
2. A command is parsed out of each line by collecting the prefix composed
of characters in the identchars member.
-3. A command `foo' is dispatched to a method 'do_foo()'; the do_ method
+3. A command 'foo' is dispatched to a method 'do_foo()'; the do_ method
is passed a single argument consisting of the remainder of the line.
4. Typing an empty line repeats the last command. (Actually, it calls the
- method `emptyline', which may be overridden in a subclass.)
-5. There is a predefined `help' method. Given an argument `topic', it
- calls the command `help_topic'. With no arguments, it lists all topics
+ method 'emptyline', which may be overridden in a subclass.)
+5. There is a predefined 'help' method. Given an argument 'topic', it
+ calls the command 'help_topic'. With no arguments, it lists all topics
with defined help_ functions, broken into up to three topics; documented
commands, miscellaneous help topics, and undocumented commands.
-6. The command '?' is a synonym for `help'. The command '!' is a synonym
- for `shell', if a do_shell method exists.
+6. The command '?' is a synonym for 'help'. The command '!' is a synonym
+ for 'shell', if a do_shell method exists.
7. If completion is enabled, completing commands will be done automatically,
and completing of commands args is done by calling complete_foo() with
arguments text, line, begidx, endidx. text is string we are matching
@@ -23,21 +23,21 @@ Interpreters constructed with this class obey the following conventions:
indexes of the text being matched, which could be used to provide
different completion depending upon which position the argument is in.
-The `default' method may be overridden to intercept commands for which there
+The 'default' method may be overridden to intercept commands for which there
is no do_ method.
-The `completedefault' method may be overridden to intercept completions for
+The 'completedefault' method may be overridden to intercept completions for
commands that have no complete_ method.
-The data member `self.ruler' sets the character used to draw separator lines
+The data member 'self.ruler' sets the character used to draw separator lines
in the help messages. If empty, no ruler line is drawn. It defaults to "=".
-If the value of `self.intro' is nonempty when the cmdloop method is called,
+If the value of 'self.intro' is nonempty when the cmdloop method is called,
it is printed out on interpreter startup. This value may be overridden
via an optional argument to the cmdloop() method.
-The data members `self.doc_header', `self.misc_header', and
-`self.undoc_header' set the headers used for the help function's
+The data members 'self.doc_header', 'self.misc_header', and
+'self.undoc_header' set the headers used for the help function's
listings of documented functions, miscellaneous topics, and undocumented
functions respectively.
"""