Backfill initial yard docs #52
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
ms-ati
commented
Oct 5, 2020
ms-ati
commented
Oct 5, 2020
ms-ati
commented
Oct 5, 2020
ms-ati
commented
Oct 5, 2020
|
See #34 |
ms-ati
force-pushed
the
backfill-initial-yard-docs
branch
4 times, most recently
from
7473fa3
to
7aa734d
Compare
jemmaissroff
suggested changes
Oct 6, 2020
jemmaissroff
approved these changes
Oct 6, 2020
* Add yard-doctest and run in CI on Ruby 2.7 * Add --no-private yardopt to hide private APIs from docs * Doc MemoWise.has_arg? (and make private) * Doc MemoWise.has_kwarg? (and make private) * Doc MemoWise.prepended as private, and * Doc MemoWise#initialize * Doc MemoWise#reset_memo_wise * Doc MemoWise#preset_memo_wise * Remove reset_all_memo_wise (add to reset_memo_wise) * Fix GFM table (benchmark results) - add redcarpet dependency * Fix benchmarks to run on new Ruby patch versions, e.g. 2.7.2
ms-ati
force-pushed
the
backfill-initial-yard-docs
branch
from
8848975
to
b1a349e
Compare
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.
First pass through the MemoWise module. Includes all of the non-metaprogrammed class and instance methods. Excludes all of the meta-programmed methods, which will come in a separate PR after we figure out the best way to document them.
We add examples in the YARD doc comments which are tested using the
yard doctestplugin.