Skip to content

Commit

Permalink
fix: add a missing space in the help pages pathto -> path to (#443)
Browse files Browse the repository at this point in the history
* docs: fix typo `pathto` -> `path to`
* fix(help): added the missing space `pathto` -> `path to`

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Co-authored-by: Jan Kowalleck <jan.kowalleck@gmail.com>
  • Loading branch information
sharkwouter and jkowalleck authored Nov 15, 2022
1 parent b2a97e0 commit bc5fe57
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,16 +69,16 @@ optional arguments:
Build a SBOM based on the packages installed in your
current Python environment (default)
-p, --p, --poetry Build a SBOM based on a Poetry poetry.lock's contents.
Use with -i to specify absolute pathto a `poetry.lock`
Use with -i to specify absolute path to a `poetry.lock`
you wish to use, else we'll look for one in the
current working directory.
-pip, --pip Build a SBOM based on a PipEnv Pipfile.lock's
contents. Use with -i to specify absolute pathto a
contents. Use with -i to specify absolute path to a
`Pipefile.lock` you wish to use, else we'll look for
one in the current working directory.
-r, --r, --requirements
Build a SBOM based on a requirements.txt's contents.
Use with -i to specify absolute pathto a
Use with -i to specify absolute path to a
`requirements.txt` you wish to use, else we'll look
for one in the current working directory.
-X Enable debug output
Expand Down
6 changes: 3 additions & 3 deletions cyclonedx_py/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -179,19 +179,19 @@ def get_arg_parser(*, prog: Optional[str] = None) -> argparse.ArgumentParser:
)
input_group.add_argument(
'-p', '--p', '--poetry', action='store_true',
help='Build a SBOM based on a Poetry poetry.lock\'s contents. Use with -i to specify absolute path'
help='Build a SBOM based on a Poetry poetry.lock\'s contents. Use with -i to specify absolute path '
'to a `poetry.lock` you wish to use, else we\'ll look for one in the current working directory.',
dest='input_from_poetry'
)
input_group.add_argument(
'-pip', '--pip', action='store_true',
help='Build a SBOM based on a PipEnv Pipfile.lock\'s contents. Use with -i to specify absolute path'
help='Build a SBOM based on a PipEnv Pipfile.lock\'s contents. Use with -i to specify absolute path '
'to a `Pipefile.lock` you wish to use, else we\'ll look for one in the current working directory.',
dest='input_from_pip'
)
input_group.add_argument(
'-r', '--r', '--requirements', action='store_true',
help='Build a SBOM based on a requirements.txt\'s contents. Use with -i to specify absolute path'
help='Build a SBOM based on a requirements.txt\'s contents. Use with -i to specify absolute path '
'to a `requirements.txt` you wish to use, else we\'ll look for one in the current working directory.',
dest='input_from_requirements'
)
Expand Down
6 changes: 3 additions & 3 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,16 @@ The full documentation can be issued by running with ``--help``:
Build a SBOM based on the packages installed in your
current Python environment (default)
-p, --p, --poetry Build a SBOM based on a Poetry poetry.lock's contents.
Use with -i to specify absolute pathto a `poetry.lock`
Use with -i to specify absolute path to a `poetry.lock`
you wish to use, else we'll look for one in the
current working directory.
-pip, --pip Build a SBOM based on a PipEnv Pipfile.lock's
contents. Use with -i to specify absolute pathto a
contents. Use with -i to specify absolute path to a
`Pipefile.lock` you wish to use, else we'll look for
one in the current working directory.
-r, --r, --requirements
Build a SBOM based on a requirements.txt's contents.
Use with -i to specify absolute pathto a
Use with -i to specify absolute path to a
`requirements.txt` you wish to use, else we'll look
for one in the current working directory.
-X Enable debug output
Expand Down

0 comments on commit bc5fe57

Please sign in to comment.