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

Docs: add @uses tags for inherited public properties #321

Merged
merged 1 commit into from
Nov 3, 2023

Conversation

jrfnl
Copy link
Collaborator

@jrfnl jrfnl commented Nov 3, 2023

Some sniffs use traits and inherit public properties, which can be set from a ruleset, from a trait.

To make this more obvious, annotate inherited public properties for a sniff via a @uses tag.

Some sniffs use traits and inherit `public` properties, which can be set from a ruleset, from a trait.

To make this more obvious, annotate inherited `public` properties for a sniff via a `@uses` tag.
@coveralls
Copy link

Coverage Status

coverage: 97.644%. remained the same
when pulling 13c4804 on JRF/yoastcs-doc-add-uses-tags
into 86045c2 on develop.

@jrfnl jrfnl merged commit ea7a873 into develop Nov 3, 2023
37 checks passed
@jrfnl jrfnl deleted the JRF/yoastcs-doc-add-uses-tags branch November 3, 2023 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants