ruleguard: add support for structured doc comments #227
Conversation
This file contains 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
quasilyte
force-pushed
the
quasilyte/feature/gorule_docs
branch
2 times, most recently
from
0193f65
to
057ebee
Compare
A matcher function can now use 4 special pragmas: * `doc:summary` for a short description * `doc:before` for an example of a "bad code" * `doc:after` for a fixed code example * `doc:tags` for a list of custom tags It's planned to make it possible for the integrating app to access that information in a convenient way. This PR is moslty about enabling on a parsing level. These 4 fields (summary, before, after, tags) are selected as something that is close to the `go-critic` checker documentation model.
quasilyte
force-pushed
the
quasilyte/feature/gorule_docs
branch
from
057ebee
to
35a5546
Compare
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.
A matcher function can now use 4 special pragmas:
It's planned to make it possible for the integrating app
to access that information in a convenient way.
This PR is moslty about enabling on a parsing level.
These 4 fields (summary, before, after, tags) are selected
as something that is close to the
go-criticchecker documentation model.