Skip to content

docs(core): correct ref-pattern grammar and cover the * + ** combination - #1

Open
alexwbend wants to merge 1 commit into
mainfrom
patch-1
Open

docs(core): correct ref-pattern grammar and cover the * + ** combination#1
alexwbend wants to merge 1 commit into
mainfrom
patch-1

Conversation

@alexwbend

Copy link
Copy Markdown
Owner

What this does

Corrects the RefPattern grammar doc in git_perms.rs, which described the
grammar as only literals and single * and said "No **" — even though **
(recursive wildcard) is a supported, tested feature. Also adds a unit test for
the *-then-** combination (refs/*/**), which had no coverage.

Why

The grammar docs mislead contributors: reading them you'd think refs/heads/**
is invalid, when it's implemented, documented on matches(), and tested.

How to test

cargo test -p buzz-core git_perms — the new pattern_wildcard_before_recursive_wildcard
test passes and no existing tests change. Doc-only otherwise; cargo doc -p buzz-core still builds.

Notes

No behavior change — parser and matcher untouched; only a doc comment and one
additive test. Followed the existing doc style in this file. No existing open PR found.

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.

1 participant