Skip to content
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

mention that known-bug test directive takes arguments #2288

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tshepang
Copy link
Member

Closes #2261

Comment on lines +418 to +422
This directive takes comma-separated issue numbers as arguments,
each prefixed with a `#`.
Examples are `//@ known-bug: #12345` and `//@ known-bug: #123, #456`.
Arbitrary text before the `#` is also accepted,
example being `rust-lang/rust#12345`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: probably sth like

The known-bug directive accepts issue numbers or "unknown". Valid forms:

  • //@ known-bug: #123456 (when the issue is on rust-lang/rust)
  • //@ known-bug: rust-lang/chalk#123456 (when the issue is on another repo)
  • //@ known-bug: unknown (when there is no known issue yet; preferrably open one if it does not already exist)

@jieyouxu jieyouxu added S-waiting-on-author Status: this PR is waiting for additional action by the OP T-bootstrap Relevant to bootstrap team labels Mar 17, 2025
@jieyouxu jieyouxu self-assigned this Mar 17, 2025
@tshepang tshepang changed the title mention that know-bug test directive takes arguments mention that known-bug test directive takes arguments Mar 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-author Status: this PR is waiting for additional action by the OP T-bootstrap Relevant to bootstrap team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

known-bug directive syntax is not documented
2 participants