Fix broken YARD documents #1484
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
manicmaniac
force-pushed
the
fix-yard-doc
branch
2 times, most recently
from
fe3c943
to
d57adb2
Compare
manicmaniac
force-pushed
the
fix-yard-doc
branch
2 times, most recently
from
dc4f9b2
to
7d5d818
Compare
manicmaniac
force-pushed
the
fix-yard-doc
branch
from
7d5d818
to
834de8d
Compare
manicmaniac
commented
Feb 12, 2024
Comment on lines
+3
to
+4
| --tag tags:tags | ||
| --tag availability:availability |
There was a problem hiding this comment.
It does the same as PluginParser does but in the command-line option form.
danger/lib/danger/plugin_support/plugin_parser.rb
Lines 58 to 59 in 4f0de68
manicmaniac
commented
Feb 12, 2024
| @@ -13,12 +13,13 @@ module Danger | |||
| # If it's not called again on subsequent runs. | |||
| # | |||
| # Each of `message`, `warn`, `fail` and `markdown` support multiple passed arguments | |||
| # @example | |||
There was a problem hiding this comment.
@example tag needs the title.
manicmaniac
commented
Feb 12, 2024
| @@ -46,6 +46,8 @@ def messages_are_equivalent(m1, m2) | |||
| m1 == m2 | |||
| end | |||
|
|
|||
| # @endgroup | |||
There was a problem hiding this comment.
Without @endgroup, the rest lines in this file are treated as in the same group.
orta
approved these changes
Feb 12, 2024
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.
Overview
Close #1483
Currently API document hosted in https://rubydoc.info/gems/danger/ looks broken.
This PR fixes those problems.
Screenshots