Adding Yard Tags into a template #20
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
skatkov
changed the title
skatkov
commented
Dec 16, 2024
skatkov
changed the title
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.
Yard object have tags linked to them
https://rubydoc.info/gems/yard/file/docs/TagsArch.md
These tags contain a lot of useful information - returned type, accepted attributes, deprecation notices, links to more documentation and etc.
It's a pity that yard-markdown doesn't include that information, this is a PR that resolves that. I'm going through all possible tags that CodeObject has associated and adding them to output.
Technical part
I added
example_yard.rbfile that we can use to generate yard example, that has these yard tags.example.rbgo renamed toexample_rdoc.rbto align with this naming.