[#482] Add the Rubocop cop to enforce YARD documentation for public methods #500
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
malparty
changed the title
malparty
force-pushed
the
chore/gh-482-add-cop-to-enforce-yard-doc
branch
from
7849722 to
7529ef5
Compare
malparty
requested review from
aetheryna,
andyduong1920,
bterone,
byhbt,
carryall,
Goose97,
hoangmirs,
longnd,
vnntsu and
tyrro
as code owners
sanG-github
approved these changes
Jan 10, 2024
Goose97
approved these changes
Jan 10, 2024
This was referenced Jan 11, 2024
Merged
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.
What happened 👀
Enable the cop to enforce public methods YARD documentation.
Insight 📝
n/aProof Of Work 📹
The generated app passes the Rubocop check after adding the documentation to 1 public method (in the SVG helper):