Skip to content

Fix broken YARD documents#1484

Merged
manicmaniac merged 14 commits into
danger:masterfrom
manicmaniac:fix-yard-doc
Feb 12, 2024
Merged

Fix broken YARD documents#1484
manicmaniac merged 14 commits into
danger:masterfrom
manicmaniac:fix-yard-doc

Conversation

@manicmaniac

@manicmaniac manicmaniac commented Feb 12, 2024

Copy link
Copy Markdown
Member

Overview

Close #1483

Currently API document hosted in https://rubydoc.info/gems/danger/ looks broken.

  • All comments are written in GitHub-Flavored Markdown but YARD recognizes them as RDoc
  • There's some typos, misindentations and misused tags

This PR fixes those problems.

Screenshots

before after
image image

@manicmaniac manicmaniac force-pushed the fix-yard-doc branch 2 times, most recently from fe3c943 to d57adb2 Compare February 12, 2024 09:34
@manicmaniac manicmaniac self-assigned this Feb 12, 2024
@manicmaniac manicmaniac force-pushed the fix-yard-doc branch 2 times, most recently from dc4f9b2 to 7d5d818 Compare February 12, 2024 14:36
Comment thread .yardopts
Comment on lines +3 to +4
--tag tags:tags
--tag availability:availability

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does the same as PluginParser does but in the command-line option form.

YARD::Tags::Library.define_tag('tags', :tags)
YARD::Tags::Library.define_tag('availability', :availability)

# If it's not called again on subsequent runs.
#
# Each of `message`, `warn`, `fail` and `markdown` support multiple passed arguments
# @example

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@example tag needs the title.

m1 == m2
end

# @endgroup

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without @endgroup, the rest lines in this file are treated as in the same group.

@manicmaniac manicmaniac marked this pull request as ready for review February 12, 2024 14:55
@manicmaniac manicmaniac merged commit 1efd102 into danger:master Feb 12, 2024
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.

YARD document does not render Markdown

2 participants