Skip to content

Only check for the @type annotation on tests #48

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

Merged
merged 5 commits into from
Jul 10, 2018

Conversation

rossmitchell
Copy link
Contributor

At the moment the Annotation check looks at all public functions with a
docblock, however at time you may want to document methods that are not
tests, for example a data provider. As these won't have the small /
medium annotations the check will fail.

This updates the check to only test docblocks that conatin @test within
them, which is the only place the annotation should appear

At the moment the Annotation check looks at all public functions with a
docblock, however at time you may want to document methods that are not
tests, for example a data provider. As these won't have the small /
medium annotations the check will fail.

This updates the check to only test docblocks that conatin @test within
them, which is the only place the annotation should appear
@edmondscommerce
Copy link
Owner

would suggest we also check for methods beginning test...

whilst EC is suggesting to use the @test annotation, its going to common enough to have methods beginning test but we should still require the annotation

@edmondscommerce edmondscommerce merged commit 8075c13 into master Jul 10, 2018
@edmondscommerce edmondscommerce deleted the onlyCheckForAnnotationsOnTests branch July 10, 2018 09:31
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.

2 participants