Improve yardoc tags for better documentation #10193
Draft
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
ekohl
commented
May 31, 2024
Comment on lines
+24
to
+25
| # | ||
| module Foreman |
There was a problem hiding this comment.
I'm not sure how to convince yard that the above is a license and not a code comment. Suggestions welcome.
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.
When using
yardoc serverto serve the documentation, theForemannamespace was incorrectly documented. This makes sure some files are readable. Obviously it's far from ready.This came up in a discussion about developer docs: https://community.theforeman.org/t/rfc-improve-developer-documentation-and-learning-resources/38167.