Skip to content

Commit

Permalink
Merge pull request #2311 from crytic/dev-slither-prop
Browse files Browse the repository at this point in the history
properties, documentation: correct tool descriptions and usage
  • Loading branch information
0xalpharush authored Feb 17, 2024
2 parents 65fcb4b + 9996e4e commit 82645a9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
5 changes: 4 additions & 1 deletion slither/tools/documentation/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,10 @@ def parse_args() -> argparse.Namespace:
Parse the underlying arguments for the program.
:return: Returns the arguments for the program.
"""
parser = argparse.ArgumentParser(description="Demo", usage="slither-documentation filename")
parser = argparse.ArgumentParser(
description="Auto-generate NatSpec documentation for every function using OpenAI Codex.",
usage="slither-documentation filename",
)

parser.add_argument("project", help="The target directory/Solidity file.")

Expand Down
6 changes: 3 additions & 3 deletions slither/tools/properties/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,13 @@ def parse_args() -> argparse.Namespace:
:return: Returns the arguments for the program.
"""
parser = argparse.ArgumentParser(
description="Demo",
usage="slither-demo filename",
description="Generates code properties (e.g., invariants) that can be tested with unit tests or Echidna, entirely automatically.",
usage="slither-prop filename",
formatter_class=argparse.RawDescriptionHelpFormatter,
)

parser.add_argument(
"filename", help="The filename of the contract or truffle directory to analyze."
"filename", help="The filename of the contract or project directory to analyze."
)

parser.add_argument("--contract", help="The targeted contract.")
Expand Down

0 comments on commit 82645a9

Please sign in to comment.