Skip to content

Commit

Permalink
More docs
Browse files Browse the repository at this point in the history
Signed-off-by: Andrea Zoppi <[email protected]>
  • Loading branch information
TexZK committed Mar 7, 2024
1 parent a44c244 commit 660e14e
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ Command Line Interface

.. click:: hexrec.cli:main
:prog: hexrec
:show-nested:
:nested: full
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ authors = [{name = "Andrea Zoppi", email = "[email protected]"}]
classifiers = [
# complete classifier list:
# http://pypi.python.org/pypi?%3Aaction=list_classifiers
"Development Status :: 3 - Alpha",
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
Expand Down
18 changes: 11 additions & 7 deletions src/hexrec/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ def main() -> None:
Forces the output file format.
By default it is that of the input file.
""")
@click.option('-m', '--modulo', type=BYTE_INT, default=4, help="""
@click.option('-m', '--modulo', type=BYTE_INT, default=4, show_default=True, help="""
Alignment modulo.
""")
@click.option('-s', '--start', type=BASED_INT, help="""
Expand All @@ -332,7 +332,7 @@ def main() -> None:
Exclusive end address. Negative values are referred to the end of the data.
By default it applies till the end of the data contents.
""")
@click.option('-v', '--value', type=BYTE_INT, default=0, help="""
@click.option('-v', '--value', type=BYTE_INT, default=0, show_default=True, help="""
Byte value used to flood alignment padding.
""")
@click.option('-w', '--width', type=BASED_INT, help="""
Expand Down Expand Up @@ -568,7 +568,7 @@ def delete(
Forces the output file format.
By default it is that of the input file.
""")
@click.option('-v', '--value', type=BYTE_INT, default=0xFF, help="""
@click.option('-v', '--value', type=BYTE_INT, default=0, show_default=True, help="""
Byte value used to fill the address range.
""")
@click.option('-s', '--start', type=BASED_INT, help="""
Expand Down Expand Up @@ -620,7 +620,7 @@ def fill(
Forces the output file format.
By default it is that of the input file.
""")
@click.option('-v', '--value', type=BYTE_INT, default=0xFF, help="""
@click.option('-v', '--value', type=BYTE_INT, default=0, show_default=True, help="""
Byte value used to flood the address range.
""")
@click.option('-s', '--start', type=BASED_INT, help="""
Expand Down Expand Up @@ -1056,7 +1056,9 @@ def srec() -> None:
# noinspection PyShadowingBuiltins
@srec.command()
@click.option('-f', '--format', 'format', type=DATA_FMT_CHOICE,
default='ascii', help='Header data format.')
default='ascii', show_default=True, help="""
Header data format.
""")
@click.argument('infile', type=FILE_PATH_IN, required=False)
def get_header(
format: str,
Expand All @@ -1082,7 +1084,9 @@ def get_header(
# noinspection PyShadowingBuiltins
@srec.command()
@click.option('-f', '--format', 'format', type=DATA_FMT_CHOICE,
default='ascii', help='Header data format.')
default='ascii', show_default=True, help="""
Header data format.
""")
@click.argument('header', type=str)
@click.argument('infile', type=FILE_PATH_IN, required=False)
@click.argument('outfile', type=FILE_PATH_OUT, required=False)
Expand Down Expand Up @@ -1268,7 +1272,7 @@ def del_header(
Forces the output file format.
""")
@click.option('--seek-zeroes/--no-seek-zeroes', 'oseek_zeroes', is_flag=True,
default=True, help="""
default=True, show_default=True, help="""
Output seeking writes zeroes while seeking.
""")
@click.option('-v', '--version', is_flag=True, is_eager=True,
Expand Down

0 comments on commit 660e14e

Please sign in to comment.