Update with_controller_class type documentation
#2094
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
|
@TastyPi thanks for the PR! Might you add a CHANGELOG entry? |
|
@joelhawksley Done |
joelhawksley
approved these changes
Sep 16, 2024
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.
What are you trying to accomplish?
In Yard
[ActionController::Base]means "an instance ofActionController::Base, but this method actually wants a subclass. Tools such as RubyMine complain that the expected type is incorrect when that's not true.What approach did you choose and why?
Fixed the doc to use
[Class<ActionController::Base>]which is the correct type signatire for this meythod.Anything you want to highlight for special attention from reviewers?
No