-
Notifications
You must be signed in to change notification settings - Fork 1k
docs: add advanced usage examples for CLI & Python API #265
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: add advanced usage examples for CLI & Python API #265
Conversation
|
After considering this pr for a while I think this represent too much information for the main readme The added new patterns section pushes back the first time you see the python usage and I think that's not something we want: gitingest aims to be simple to onboard and use for the first time, ideally the python usage should even surface higher in the readme So I'll be closing this PR, I hope it makes sense |
Title: Docs: Add Advanced Usage Examples to README
Body:
This PR enhances the
README.mdby adding examples for more advanced usage scenarios that were not previously covered, aiming to improve user understanding and usability.Motivation:
The current README examples cover basic usage well, but lack demonstrations for:
include_patternsandexclude_patternsfor more complex filtering logic.Adding these examples makes the tool's capabilities clearer for common and powerful use cases.
Changes Made:
Added Subsection to CLI Usage:
-e/--exclude-patternand-i/--include-patternmultiple times in a single command.Added Subsection to Python API Usage:
include_patternsandexclude_patternsarguments together.src/directory within a branch).ingest) and asynchronous (ingest_async) functions.Verification:
gitingesttool.This contribution aims to make it easier for users to leverage the pattern-matching features of
gitingesteffectively through both its command-line and Python interfaces.