Update and fixup ActionController::Parameters docs #48250
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
- Small wording tweaks for grammar or consistency - Add links to methods/classes when possible, and fix some cases where there were links but shouldn't be (`API`, `Testing`, etc.) - Fixed `call-seq` for `each_key` - Change `has_key?`, `key?`, and `member?` to aliases instead of delegates so that they are documented as aliases (This is how the methods are documented for Hash in Ruby) - Remove explicit "also aliased as" docs because rdoc does this already - Add `:nodoc:` to `EMPTY_ARRAY` and `EMPTY_HASH` constants since these are internal optimizations
|
Thank you, @skipkayhil! 🗒️ Backported to |
jonathanhefner
added a commit
that referenced
this pull request
May 26, 2023
Update and fixup ActionController::Parameters docs (cherry picked from commit 1e34bf8)
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.
Detail
API,Testing, etc.)call-seqforeach_keyhas_key?,key?, andmember?to aliases instead of delegates so that they are documented as aliases (This is how the methods are documented for Hash in Ruby):nodoc:toEMPTY_ARRAYandEMPTY_HASHconstants since these are internal optimizationsAdditional Information
Not skipping CI because of the
delegate->alias_methodchangeChecklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number]