Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/improve documentation for cli options. #763

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from

Conversation

mgiagante
Copy link
Contributor

This PR aims to solve Issue 534 by:

  • Expanding the explanation on how --src, --path-includes and --path-excludes work in the output for --help.
  • Additionally, README.md and aderyn/README.md are updated accordingly.

The comments in this foundry-compilers pull request were used as a reference as well.

@mgiagante
Copy link
Contributor Author

@TilakMaddy @alexroan please let me know if there are any other options that could benefit from a more thorough explanation or examples.

@TilakMaddy TilakMaddy added the external-contribution When an external member contributes a PR label Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
external-contribution When an external member contributes a PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants