Skip to content

Document gitignore inputs that raise despite being accepted by Git #148

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.

Sign up for GitHub

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

Closed
rupayon123 wants to merge 1 commit into from
Closed

Document gitignore inputs that raise despite being accepted by Git #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions pathspec/patterns/gitignore/basic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,14 @@ def pattern_to_regex(
"""
Convert the pattern into a regular expression.

Raises :class:`~pathspec.patterns.gitignore.base.GitIgnorePatternError`
for invalid patterns, including a bare ``!`` (also when followed by
unescaped trailing spaces) or an unmatched trailing backslash. Unlike
blank lines and comments, these inputs do not return ``(None, None)``.
Git accepts these lines without a diagnostic, so callers reading ignore
files must be prepared to handle this exception even when Git accepts
the file.

*pattern* (:class:`str` or :class:`bytes`) is the pattern to convert into a
regular expression.

Expand Down
8 changes: 8 additions & 0 deletions pathspec/patterns/gitignore/spec.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,14 @@ def pattern_to_regex(
"""
Convert the pattern into a regular expression.

Raises :class:`~pathspec.patterns.gitignore.base.GitIgnorePatternError`
for invalid patterns, including a bare ``!`` (also when followed by
unescaped trailing spaces) or an unmatched trailing backslash. Unlike
blank lines and comments, these inputs do not return ``(None, None)``.
Git accepts these lines without a diagnostic, so callers reading ignore
files must be prepared to handle this exception even when Git accepts
the file.

*pattern* (:class:`str` or :class:`bytes`) is the pattern to convert into a
regular expression.

Expand Down