Trick RDoc to pickup ActiveRecord::Core#values_at #48324
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
jonathanhefner
added a commit
that referenced
this pull request
Oct 7, 2023
When a `:method:` doc is immediately followed by the `private` keyword, RDoc will hide that doc as if it were a private method. In #48324, the `:method:` docs for `ActiveRecord::Core#slice` and `ActiveRecord::Core#values_at` were swapped in an attempt to force `values_at` to appear in the rendered docs. However, doing so causes `slice` to dissappear from the rendered docs. To ensure that `slice` and `values_at` both appear in the rendered docs, this commit moves their `:method:` docs away from the `private` keyword in `ActiveRecord::Core`.
|
It turns out the problem is the I also grepped for similar occurrences and found |
jonathanhefner
added a commit
that referenced
this pull request
Oct 7, 2023
When a `:method:` doc is immediately followed by the `private` keyword, RDoc will hide that doc as if it were a private method. In #48324, the `:method:` docs for `ActiveRecord::Core#slice` and `ActiveRecord::Core#values_at` were swapped in an attempt to force `values_at` to appear in the rendered docs. However, doing so causes `slice` to dissappear from the rendered docs. To ensure that `slice` and `values_at` both appear in the rendered docs, this commit moves their `:method:` docs away from the `private` keyword in `ActiveRecord::Core`. (cherry picked from commit c8b3642)
|
@jonathanhefner Nice work, and thanks for following up! I've filed a bug with Ruby: |
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.
Before
(Notice the missing "V" methods)
After
First, this came from #44544, something I found surprising was that these are the only methods documented on
ActiveModel::Model. But my guess is that because the other methods are available by include, it makes sense to document them there -- whileActiveModel::Accessis private?/cc @jonathanhefner
Second, I do not know why swapping the order here works. I've tried inspecting RDoc internals and using debug mode, but there was no apparent reason why the method was being dropped. Meanwhile, the same order works fine for
ActiveModel::Model. 馃し