Fix docs, bump version number for PyPI

treykeown · Jun 23, 2023 · 6f1c3dd · 6f1c3dd
1 parent 6f6dd5d
commit 6f1c3dd
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -106,7 +106,7 @@ Don't want to write any code? Simply pass any Python script to `arguably` to giv
 </sub></div>
 
 ```console
-user@machine:~$ python3 -m arguably etc/scripts/party-trick.py -h
+user@machine:~$ python3 -m arguably party-trick.py -h
 usage: party-trick [-h] [--version] command ...
 
 this is the docstring for the whole script

diff --git a/arguably/_context.py b/arguably/_context.py
@@ -510,7 +510,7 @@ def run(
         Examples:
             ```python
             #!/usr/bin/env python3
-            \"\"\"description for this script'''
+            \"\"\"description for this script\"\"\"
             from io import StringIO
 
             import arguably

diff --git a/arguably/arg.py b/arguably/arg.py
@@ -114,7 +114,7 @@ def choices(*choices: Union[str, enum.Enum]) -> mods.ChoicesModifier:
         def move(
             direction: Annotated[str, arguably.arg.choices("left", "right", "up", "down")]
         ):
-            \"\"\"An enum is usually recommended for cases like this'''
+            \"\"\"An enum is usually recommended for cases like this\"\"\"
             print(f"{direction=}")
 
         if __name__ == "__main__":

diff --git a/docs/why.md b/docs/why.md
@@ -116,7 +116,7 @@ class SomeClass:
 ```
 
 ```console
-user@machine:~$ python3 -m arguably etc/scripts/party-trick.py -h
+user@machine:~$ python3 -m arguably party-trick.py -h
 usage: party-trick [-h] [--version] command ...
 
 this is the docstring for the whole script
@@ -135,7 +135,7 @@ options:
 ```
 
 ```console
-user@machine:~$ python3 -m arguably etc/scripts/party-trick.py hello -h
+user@machine:~$ python3 -m arguably party-trick.py hello -h
 usage: party-trick hello [-h] name
 
 this is hello's docstring
@@ -148,7 +148,7 @@ options:
 ```
 
 ```console
-user@machine:~$ python3 -m arguably etc/scripts/party-trick.py hello world
+user@machine:~$ python3 -m arguably party-trick.py hello world
 Hello, world!
 ```
 

diff --git a/etc/pypi/PYPI_README.md b/etc/pypi/PYPI_README.md
@@ -103,7 +103,7 @@ Don't want to write any code? Simply pass any Python script to `arguably` to giv
 </sub></div>
 
 ```console
-user@machine:~$ python3 -m arguably etc/scripts/party-trick.py -h
+user@machine:~$ python3 -m arguably party-trick.py -h
 usage: party-trick [-h] [--version] command ...
 
 this is the docstring for the whole script

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "arguably"
-version = "1.2.3"
+version = "1.2.4"
 description = "The best Python CLI library, arguably."
 authors = ["treykeown <[email protected]>"]
 readme = "etc/pypi/PYPI_README.md"