Skip to content

Commit 31731aa

Browse files
committed
More minor working improvements
1 parent 71e8ae7 commit 31731aa

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

docs/api/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
These pages document the public API for `cmd2`. If a method, class, function, attribute, or constant
44
is not documented here, consider it private and subject to change. There are many classes, methods,
5-
functions, and constants in the source code which do not begin with an underscore but are not
5+
functions, and constants in the source code that do not begin with an underscore but are not
66
documented here. When looking at the source code for this library, you cannot safely assume that
7-
because something doesn't start with an underscore, it is a public API.
7+
something is a public API just because it doesn't start with an underscore.
88

99
If a release of this library changes any of the items documented here, the version number will be
1010
incremented according to the [Semantic Version Specification](https://semver.org).
@@ -18,7 +18,7 @@ incremented according to the [Semantic Version Specification](https://semver.org
1818
- [cmd2.colors](./colors.md) - StrEnum of all color names supported by the Rich library
1919
- [cmd2.command_definition](./command_definition.md) - supports the definition of commands in
2020
separate classes to be composed into cmd2.Cmd
21-
- [cmd2.constants](./constants.md) - just like it says on the tin
21+
- [cmd2.constants](./constants.md) - constants used in `cmd2`
2222
- [cmd2.decorators](./decorators.md) - decorators for `cmd2` commands
2323
- [cmd2.exceptions](./exceptions.md) - custom `cmd2` exceptions
2424
- [cmd2.history](./history.md) - classes for storing the history of previously entered commands

docs/examples/alternate_event_loops.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Alternate Event Loops
22

3-
Throughout this documentation we have focused on the **90%** use case, that is the use case we
4-
believe around **90+%** of our user base is looking for. This focuses on ease of use and the best
5-
out-of-the-box experience where developers get the most functionality for the least amount of
6-
effort. We are talking about running `cmd2` applications with the `cmdloop()` method:
3+
Throughout this documentation, we have focused on the 90% use case, which we believe applies to over
4+
90% of our user base. This focuses on ease of use and the best out-of-the-box experience, where
5+
developers get the most functionality for the least amount of effort. We are talking about running
6+
`cmd2` applications with the `cmdloop()` method:
77

88
```py
99
from cmd2 import Cmd
@@ -21,8 +21,8 @@ Many Python concurrency libraries involve or require an event loop which they ar
2121
such as [asyncio](https://docs.python.org/3/library/asyncio.html), [gevent](http://www.gevent.org/),
2222
[Twisted](https://twistedmatrix.com), etc.
2323

24-
`cmd2` applications can be executed in a fashion where `cmd2` doesn't own the main loop for the
25-
program by using code like the following:
24+
`cmd2` applications can be executed in a way where `cmd2` doesn't own the main loop for the program
25+
by using code like the following:
2626

2727
```py
2828
import cmd2
@@ -64,9 +64,9 @@ normal fashion:
6464
1. Stop redirecting output if it was redirected
6565
1. Call methods registered with [cmd2.Cmd.register_cmdfinalization_hook][]
6666

67-
Running in this fashion enables the ability to integrate with an external event loop. However, how
68-
to integrate with any specific event loop is beyond the scope of this documentation. Please note
69-
that running in this fashion comes with several disadvantages, including:
67+
Running in this way enables the ability to integrate with an external event loop. However, how to
68+
integrate with any specific event loop is beyond the scope of this documentation. Please note that
69+
running in this fashion comes with several disadvantages, including:
7070

7171
- Requires the developer to write more code
7272
- Does not support transcript testing

docs/examples/getting_started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Getting Started
22

3-
Here's a quick walkthrough of a the simple
3+
Here's a quick walkthrough of the simple
44
[getting_started.py](https://github.com/python-cmd2/cmd2/blob/main/examples/getting_started.py)
55
example application which demonstrates many features of `cmd2`:
66

@@ -54,7 +54,7 @@ $ python getting_started.py
5454

5555
The application creates an instance of our class, and calls the [cmd2.Cmd.cmdloop][] method. This
5656
method accepts user input and runs commands based on that input. Because we subclassed `cmd2.Cmd`,
57-
our new app already has a bunch of features built in.
57+
our new app already has a bunch of built-in features.
5858

5959
Congratulations, you have a working `cmd2` app. You can run it, and then type `quit` to exit.
6060

@@ -87,7 +87,7 @@ you will see our `maxrepeats` setting show up with its default value of `3`.
8787

8888
## Create A Command
8989

90-
Now we will create our first command, called `speak` which will echo back whatever we tell it to
90+
Now we will create our first command, called `speak`, which will echo back whatever we tell it to
9191
say. We are going to use an [argument processor](../features/argument_processing.md) so the `speak`
9292
command can shout and talk pig latin. We will also use some built in methods for
9393
[generating output](../features/generating_output.md). Add this code to `getting_started.py`, so

0 commit comments

Comments
 (0)