docs(#221): align --skip-gitignore help text with actual behavior#249
Open
kreinba wants to merge 1 commit into
Open
docs(#221): align --skip-gitignore help text with actual behavior#249kreinba wants to merge 1 commit into
kreinba wants to merge 1 commit into
Conversation
edmoffo
approved these changes
Jun 11, 2026
edmoffo
left a comment
There was a problem hiding this comment.
Help string now matches the code path in bin/pdd:71-78, where --skip-gitignore reads .gitignore and folds its non-comment entries into the excludes set. Diff is one line, no code paths touched, no invariants at risk, no tests needed for a help-text change. The yamllint red comes from a missing newline in .github/workflows/actionlint.yml that the diff does not touch. No inline comments.
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
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.
Closes #221.
The
--skip-gitignoreflag's help text inbin/pdd:38claimedDon't look into .gitignore for excludes, but the code inbin/pdd:71-78does the opposite: when the flag is set and.gitignoreexists, it reads the file and folds its entries into the excludes set. Multiple users (php-coder, proofit404, avidrucker) hit this contradiction, and pnatashap suggested clarifying the description on the issue thread.The change rewrites the help string to describe the actual behavior. The flag name itself is unchanged so no downstream invocation breaks.
Ran
./bin/rake testand./bin/rubocop bin/pdd; the change introduces no new offenses or test failures. Pre-existing failures intest_skips_uncommitted_changesandtest_reads_git_authorare unrelated git-signing environmental errors.