Correct @see annotations #5
Merged
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
It seems multiple @see annotations should not be comma-separated but listed with multiple @see-s. http://www.rubydoc.info/gems/yard/file/docs/Tags.md#see
|
hah - think should work for me :D |
|
I've been wanting to do a writeup about all these gotchas once I had stabilized the danger infrastructure - danger/danger.systems#1 |
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.
It seems multiple @see annotations should not be comma-separated but listed with multiple @see-s. http://www.rubydoc.info/gems/yard/file/docs/Tags.md#see
Currently this results in a broken (and missing the others) link.
Not an expert on yard doc style at all. I went debugging the danger plugin parser and eventually settled on simply splitting the @sees lol.