docs: update README for nested .gitignore + --exclude#20
Merged
Conversation
Line 91 still claimed only the root .gitignore was read — false since 0.4.0. Document nested .gitignore resolution, the pure-filesystem scope, and the --exclude flag (usage example + configuration). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README (and therefore the PyPI landing page) described pre-0.4.0 behavior. Fixes the stale claim and documents the new feature.
Changes
.gitignoreat the root of the supplied path is consulted; nested.gitignorefiles in subdirectories are not read." — reversed in 0.4.0. It now describes nested resolution with Git precedence (deeper wins,!re-includes) and the pure-filesystem scope (no.git/info/exclude, no globalcore.excludesFile, no git invocation; works on any directory).--exclude: a usage example (--exclude node_modules --exclude dist) plus a Configuration bullet noting it augments the default.cache/.uv-cacheskips;.gitis always skipped and not configurable..gitignoreand the--excludeflag.Docs only.
🤖 Generated with Claude Code