Skip to content

docs: Fix CLI help text accuracy #332

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

Merged
merged 14 commits into from
Jul 1, 2025

Conversation

Sendi0011
Copy link
Contributor

@Sendi0011 Sendi0011 commented Jun 27, 2025

  • Add stdout documentation to --output option help text
  • Update default filename to "digest.txt" consistently
  • Enhance docstrings with comprehensive usage examples
  • Improve GitHub token documentation with environment variable support
  • Fix inconsistencies between help text and actual CLI behavior

- Add stdout documentation to --output option help text
- Update default filename to 'digest.txt' consistently
- Enhance docstrings with comprehensive usage examples
- Improve GitHub token documentation with environment variable support
- Fix inconsistencies between help text and actual CLI behavior
@cyclotruc
Copy link
Member

@Sendi0011 Hi, it seems like you have pushed some unwanted files
could you remove those? thanks

@Sendi0011
Copy link
Contributor Author

@cyclotruc The unwanted file has been deleted.

Copy link
Member

@cyclotruc cyclotruc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect! Thanks @Sendi0011 for those neat update to the docs

@cyclotruc
Copy link
Member

@Sendi0011 apparently we need to run pre-commit hooks

@Sendi0011
Copy link
Contributor Author

@cyclotruc Alright on that.

@cyclotruc
Copy link
Member

image
It seems like we have an Issue with CI here @filipchristiansen do you think it would be OK to bypass the rule since def main(**cli_kwargs: Unpack[_CLIArgs]) doesn't contain all the arguments?

@cyclotruc
Copy link
Member

Thanks @Sendi0011 and @filipchristiansen, merging

@cyclotruc cyclotruc merged commit fdcbc53 into coderamp-labs:main Jul 1, 2025
18 checks passed
@coderamp-ci coderamp-ci bot mentioned this pull request Jul 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants