Skip to content

Commit c409098

Browse files
committed
Fixed spelling errors.
1 parent 15c2881 commit c409098

21 files changed

+69
-72
lines changed

.github/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ You can run multiple tasks in a single invocation, for example::
284284
$ invoke docs sdist wheel
285285
```
286286

287-
That one command will remove all superflous cache, testing, and build
287+
That one command will remove all superfluous cache, testing, and build
288288
files, render the documentation, and build a source distribution and a
289289
wheel distribution.
290290

@@ -298,7 +298,7 @@ $ cd ~src/cmd2
298298
$ invoke pytest
299299
```
300300

301-
If the tests are executed it means that dependencies and project are installed succesfully.
301+
If the tests are executed it means that dependencies and project are installed successfully.
302302

303303
You can also run the example app and see a prompt that says "(Cmd)" running the command:
304304

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -725,7 +725,7 @@
725725
* Enhancements
726726
* Added ability to include command name placeholders in the message printed when trying to run a disabled command.
727727
* See docstring for ``disable_command()`` or ``disable_category()`` for more details.
728-
* Added instance attributes to customize error messages without having to override methods. Theses messages can
728+
* Added instance attributes to customize error messages without having to override methods. These messages can
729729
also be colored.
730730
* `help_error` - the error that prints when no help information can be found
731731
* `default_error` - the error that prints when a non-existent command is run
@@ -862,7 +862,7 @@
862862
* Aliases are now sorted alphabetically
863863
* The **set** command now tab completes settable parameter names
864864
* Added ``async_alert``, ``async_update_prompt``, and ``set_window_title`` functions
865-
* These allow you to provide feedback to the user in an asychronous fashion, meaning alerts can
865+
* These allow you to provide feedback to the user in an asynchronous fashion, meaning alerts can
866866
display when the user is still entering text at the prompt. See [async_printing.py](https://github.com/python-cmd2/cmd2/blob/master/examples/async_printing.py)
867867
for an example.
868868
* Cross-platform colored output support
@@ -962,7 +962,7 @@
962962
* New pyscript approach that provides a pythonic interface to commands in the cmd2 application.
963963
* Switch command parsing from pyparsing to custom code which utilizes shlex.
964964
* The object passed to do_* methods has changed. It no longer is the pyparsing object, it's a new Statement object, which is a subclass of ``str``. The statement object has many attributes which give you access to various components of the parsed input. If you were using anything but the string in your do_* methods, this change will require you to update your code.
965-
* ``commentGrammers`` is no longer supported or available. Comments are C-style or python style.
965+
* ``commentGrammars`` is no longer supported or available. Comments are C-style or python style.
966966
* Input redirection no longer supported. Use the load command instead.
967967
* ``multilineCommand`` attribute is ``now multiline_command``
968968
* ``identchars`` is now ignored. The standardlibrary cmd uses those characters to split the first "word" of the input, but cmd2 hasn't used those for a while, and the new parsing logic parses on whitespace, which has the added benefit of full unicode support, unlike cmd or prior versions of cmd2.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99

1010
<p align="center">
11-
<a href="#the-developers-toolbox">Develper's Toolbox</a> •
11+
<a href="#the-developers-toolbox">Developer's Toolbox</a> •
1212
<a href="#philosophy">Philosophy</a> •
1313
<a href="#installation">Installation</a> •
1414
<a href="#documentation">Documentation</a> •

cmd2/argparse_custom.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ def my_choices_provider(self):
101101
an acceptable value for these arguments.
102102
103103
There are times when what's being tab completed is determined by a previous
104-
argument on the command line. In theses cases, ArgparseCompleter can pass a
104+
argument on the command line. In these cases, ArgparseCompleter can pass a
105105
dictionary that maps the command line tokens up through the one being completed
106106
to their argparse argument name. To receive this dictionary, your
107107
choices/completer function should have an argument called arg_tokens.

cmd2/transcript.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ def _escaped_find(regex: str, s: str, start: int, in_regex: bool) -> Tuple[str,
205205
# escaped. We found it.
206206
break
207207
else:
208-
# check if the slash is preceeded by a backslash
208+
# check if the slash is preceded by a backslash
209209
if s[pos - 1 : pos] == '\\':
210210
# it is.
211211
if in_regex:

docs/doc_conventions.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ Titles and Headings
5959
-------------------
6060

6161
reStructuredText allows flexibility in how headings are defined. You only have
62-
to worry about the heirarchy of headings within a single file. Sphinx magically
63-
handles the intra-file heirarchy on it's own. This magic means that no matter
62+
to worry about the hierarchy of headings within a single file. Sphinx magically
63+
handles the intra-file hierarchy on it's own. This magic means that no matter
6464
how you style titles and headings in the various files that comprise the
6565
documentation, Sphinx will render properly structured output. To ensure we have
6666
a similar consistency when viewing the source files, we use the following

docs/features/commands.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Commands
44
.. _cmd: https://docs.python.org/3/library/cmd.html
55

66
``cmd2`` is designed to make it easy for you to create new commands. These
7-
commmands form the backbone of your application. If you started writing your
7+
commands form the backbone of your application. If you started writing your
88
application using cmd_, all the commands you have built will work when you move
99
to ``cmd2``. However, there are many more capabilities available in ``cmd2``
1010
which you can take advantage of to add more robust features to your commands,
@@ -222,5 +222,3 @@ to:
222222

223223
- Define commands in separate CommandSet modules
224224
- Load or unload commands at runtime
225-
226-

docs/features/help.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Providing Help
4141
``cmd2`` makes it easy for developers of ``cmd2`` applications to provide this
4242
help. By default, the help for a command is the docstring for the ``do_*``
4343
method defining the command - e.g. for a command **foo**, that command is
44-
implementd by defining the ``do_foo`` method and the docstring for that method
44+
implemented by defining the ``do_foo`` method and the docstring for that method
4545
is the help.
4646

4747
For commands which use one of the ``argparse`` decorators to parse arguments,

docs/features/hooks.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ object, including ``.raw`` which contains exactly what the user typed.
171171

172172
The hook method must return a :class:`cmd2.plugin.PostparsingData` object, and
173173
it is very convenient to just return the object passed into the hook method.
174-
The hook method may modify the attributes of the object to influece the
174+
The hook method may modify the attributes of the object to influence the
175175
behavior of the application. If ``params.stop`` is set to true, a fatal failure
176176
is triggered prior to execution of the command, and the application exits.
177177

@@ -287,7 +287,7 @@ Any postcommand hook can change the value of the ``stop`` attribute before
287287
returning it, and the modified value will be passed to the next postcommand
288288
hook. The value returned by the final postcommand hook will be passed to the
289289
command finalization hooks, which may further modify the value. If your hook
290-
blindly returns ``False``, a prior hook's requst to exit the application will
290+
blindly returns ``False``, a prior hook's request to exit the application will
291291
not be honored. It's best to return the value you were passed unless you have a
292292
compelling reason to do otherwise.
293293

@@ -330,7 +330,7 @@ hook. The value returned by the final command finalization hook will determine
330330
whether the application terminates or not.
331331

332332
This approach to command finalization hooks can be powerful, but it can also
333-
cause problems. If your hook blindly returns ``False``, a prior hook's requst
333+
cause problems. If your hook blindly returns ``False``, a prior hook's request
334334
to exit the application will not be honored. It's best to return the value you
335335
were passed unless you have a compelling reason to do otherwise.
336336

docs/features/scripting.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ Developing an Advanced API
335335

336336
Until now the application designer has paid little attention to scripters and their needs.
337337
Wouldn't it be nice if while creating py_scripts one did not have to parse data from ``stdout``? We can
338-
accomodate the weary scripter by adding one small line at the end of our ``do_*`` commands.
338+
accommodate the weary scripter by adding one small line at the end of our ``do_*`` commands.
339339

340340
``self.last_result = <value>``
341341

@@ -446,7 +446,7 @@ app.py::
446446
self._status_cache[args.name] = status
447447

448448
self.poutput(
449-
f"Build {args.name.upper()} successfuly stared with id : {status.id}"
449+
f"Build {args.name.upper()} successfully stared with id : {status.id}"
450450
)
451451
self.last_result = status
452452

@@ -496,7 +496,7 @@ The below is a possible solution via pyscript::
496496

497497
#error checking
498498
if not result:
499-
print("Unable to determin status")
499+
print("Unable to determine status")
500500
break
501501

502502
build_status = result.data

0 commit comments

Comments
 (0)