add YARD & docs for CounterComponent #64
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
|
hey @joelhawksley, just out of curiosity, why YARD and not RDoc? |
@manuelpuyol YARD came recommended from |
nope, just curiosity haha |
|
may we add how to deploy the docs/action to deploy it? |
|
@manuelpuyol my plan was to just use https://rubydoc.info/, which will auto-publish YARD docs from this repo 😄 |
manuelpuyol
approved these changes
Sep 4, 2020
5 tasks
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.
This PR introduces documentation for our components, written in YARD.
If we like this approach, I'd recommend that we look into a tool like yardstick to ensure our documentation is complete.
cc @manuelpuyol