Skip to content

Commit 2e42895

Browse files
ScottKevillFizzadar
authored andcommitted
Fix docs-related typos
1 parent 47eb02c commit 2e42895

File tree

11 files changed

+12
-14
lines changed

11 files changed

+12
-14
lines changed

docs/api/facts.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ This fact could then be used like so:
5252
Example: getting the list of files in a directory
5353
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5454

55-
This fact returns a list of files found in a given directory. For this fact the ``command`` is delcated as a class method, indicating the fact takes arguments.
55+
This fact returns a list of files found in a given directory. For this fact the ``command`` is declared as a class method, indicating the fact takes arguments.
5656

5757
.. code:: python
5858
@@ -80,7 +80,7 @@ This fact could then be used like so:
8080
Example: getting any output from a command
8181
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8282

83-
This fact returns the raw output of any command. For this fact the ``command`` is delcated as a class method, indicating the fact takes arguments.
83+
This fact returns the raw output of any command. For this fact the ``command`` is declared as a class method, indicating the fact takes arguments.
8484

8585
.. code:: python
8686

docs/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ It is possible to limit the inventory at execution time using the `--limit` argu
7373
# Only execute against @local
7474
pyinfra inventory.py deploy.py --limit @local
7575

76-
# Only execute against hosts in the `app_servers` grouo
76+
# Only execute against hosts in the `app_servers` group
7777
pyinfra inventory.py deploy.py --limit app_servers
7878

7979
# Only execute against hosts with names matching db*

docs/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ GitHub will run all the test suites as part of any pull requests, here's how you
3838

3939
Use `pytest` to run the unit tests, or `pytest --cov` to run with coverage. Pull requests are expected to be tested and not drop overall project coverage by >1%.
4040

41-
### End to End Testst
41+
### End to End Tests
4242

4343
The end to end tests are also executed via `pytest` but not selected by default, options/usage:
4444

docs/inventory-data.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ It is possible to limit the inventory at execution time using the ``--limit`` ar
4242
# Only execute against @local
4343
pyinfra inventory.py deploy.py --limit @local
4444
45-
# Only execute against hosts in the `app_servers` grouo
45+
# Only execute against hosts in the `app_servers` group
4646
pyinfra inventory.py deploy.py --limit app_servers
4747
4848
# Only execute against hosts with names matching db*

examples/choco.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
if product_name:
99
if product_name.split()[0] == "Windows":
1010

11-
# install Chocolately
11+
# install Chocolatey
1212
choco.install()
1313

1414
choco.packages(

pyinfra/api/arguments.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ def pop_global_arguments(
269269
This is a bit strange because internally pyinfra uses non-_-prefixed arguments,
270270
and this function is responsible for the translation between the two.
271271
272-
TODO: is this wird-ness acceptable? Is it worth updating internal use to _prefix?
272+
TODO: is this weird-ness acceptable? Is it worth updating internal use to _prefix?
273273
"""
274274

275275
state = state or context.state

pyinfra/local.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def shell(
5555
5656
Args:
5757
commands (string, list): command or list of commands to execute
58-
spltlines (bool): optionally have the output split by lines
58+
splitlines (bool): optionally have the output split by lines
5959
ignore_errors (bool): ignore errors when executing these commands
6060
"""
6161

pyinfra/operations/python.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ def raise_exception(exception, *args, **kwargs):
6969
.. code:: python
7070
7171
python.raise_exception(
72-
name="Raise NotImplementedError exceptipn",
72+
name="Raise NotImplementedError exception",
7373
exception=NotImplementedError,
7474
message="This is not implemented",
7575
)

pyinfra/operations/windows_files.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ def download(
4848
4949
.. code:: python
5050
51-
winows_files.download(
51+
windows_files.download(
5252
name="Download the Docker repo file",
5353
src="https://download.docker.com/linux/centos/docker-ce.repo",
5454
dest="C:\\docker",

scripts/cleanup_words.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ def cleanup_words():
1212

1313
lines = sorted(set(lines))
1414

15-
lines.insert(0, "# it is automatically cleaned/sorted by scripts/cleaup_words.py")
15+
lines.insert(0, "# it is automatically cleaned/sorted by scripts/cleanup_words.py")
1616
lines.insert(0, "# This is a list of additional words for flake8-spellcheck")
1717

1818
with open(path.join("tests", "words.txt"), "w", encoding="utf-8") as f:

0 commit comments

Comments
 (0)