Improve some documentation and start testing our documentation examples #421
Conversation
This file contains hidden or 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
To test all of our documentation examples, you can now run:
$ bundle exec yard doctest
There are a few problems in the library that are causing issues with the
Coercion specs, so those are disabled for now. I'm going to see if I can
figure out the problem and fix it so we don't have to skip those tests.
|
Things I want to add for doc testing:
|
Here's an example of a CHANGELOG.md entry: * [#421](https://github.com/intridea/hashie/pull/421): Improve some documentation and start testing our documentation examples - [@michaelherold](https://github.com/michaelherold).Generated by 🚫 Danger |
|
This is great. Can we also have something publish the doc (versioned) on github gh-pages? Maybe part of the release or build? |
|
That would be a great long-term plan. I think the way the dry-rb project does it is interesting. |
|
I think we still want this @michaelherold. Need help? |
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.
We have two major problems with our documentation:
Related to #325, I chose YARD as the de facto documentation format. I like YARD because there are a lot of tools built around it and it is more precise in its language that TomDoc and RDoc.
I would like to see us get much closer to 100% documentation coverage.