We've simplified the documentation comment yard. #52
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
hamajyotan
force-pushed
the
improve-yard-doc
branch
from
690bb4d to
23ea882
Compare
… possible. We had previously consolidated everything into the model class, but we wanted to define it in a natural way in each location. This was a hack caused by steep's inability to resolve the issue of `class_methods`, but by reconsidering our stance toward Steep, we changed it to a more natural way of writing using `class_methods`.
* add webrick for yard server command * always specify --no-private options * add activesupport-concern plugin
hamajyotan
force-pushed
the
improve-yard-doc
branch
from
23ea882 to
7650668
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.
Specifically, we've mapped the documentation and source code locations as much as possible.
Previously, everything was integrated into ActiveRecordCompose::Model,
but now we've written it in each file and adjusted it to be more straightforward.
Previously, this was a hack that arose because Steep couldn't solve the
class_methodsproblem, but we've reconsidered our stance toward steep.Rather than trying to implement it in a way that's more natural,
we now use
steep:ignoreto work around parts that don't pass steep's type checking.As a result, we've created a more natural way of writing using
class_methods.