Add has_public_example check #470
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jun 20, 2017
ghost
suggested changes
Jun 23, 2017
src/analysis/has_public_example.d
Outdated
| if (!isPublic(decl.attributes)) | ||
| continue; | ||
|
|
||
| bool hasDdocHeader = hasDdocHeader(decl); |
src/analysis/has_public_example.d
Outdated
| override void visit(const Module mod) | ||
| { | ||
| Declaration lastDecl; | ||
| bool hasPublicUnittest = true; // reset on lastDecl assignment |
There was a problem hiding this comment.
I'd rather name this variable hasNoPublicTest and change the related relational expressions, because
- then you'll can remove the initializer.
- if you look at the use spots, you always negate the variable.
hence you'll have the same meaning with less complexity.
wilzbach
force-pushed
the
has_public_example
branch
from
497a7e4 to
de814b8
Compare
Excellent idea! |
ghost
approved these changes
Jun 25, 2017
wilzbach
force-pushed
the
has_public_example
branch
from
de814b8 to
e065d07
Compare
A check for public declaration without a documented unittest.
|
Merging this as this is a new, by-default disabled check & I can "battle-test" it on Phobos over the next weeks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a check for public declaration without a documented unittest.
As Dscanner will hopefully support selective imports soon, this is intended to be a replacement for the version currently used by Phobos (e.g. https://github.com/dlang/tools/blob/master/styles/has_public_example.d, https://github.com/dlang/phobos/blob/548630d2a9ba95f079193d7b47ed8cd685c0f7c8/posix.mak#L602).