[ci-skip] Adding options example in ActiveModel::Errors doc #41217
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
gmcgibbon
reviewed
Jan 27, 2021
| @@ -381,6 +381,11 @@ def group_by_attribute | |||
| # If +type+ is a proc, it will be called, allowing for things like | |||
| # <tt>Time.now</tt> to be used within an error. | |||
| # | |||
| # If +type+ is compatible, +options+ will be injected in the translation. | |||
There was a problem hiding this comment.
Instead of placing this here, I would put it directly under the If +type+ is a symbol... line and add an example with and without interpolation like:
person.errors.add(:name, :blank)
person.errors.messages
# => {:name=>["can't be blank"]}
person.errors.add(:name, :too_long, { count: 25 })
person.errors.messages
# => ["is too long (maximum is 25 characters)"]
There was a problem hiding this comment.
That's indeed a nicer way to do it, thank !
|
Could you please squash your commits in one? |
kamipo
reviewed
Feb 2, 2021
| # person.errors.add(:name, :blank) | ||
| # person.errors.messages | ||
| # # => {:name=>["can't be blank"]} | ||
|
|
Place errors with variable example under the `type is a symbol` block Closes rails#41124
Vin0uz
force-pushed
the
active-model-errors-add-doc
branch
from
aef697f
to
da0e869
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.
馃憢
This diff closes #41124
As stated in the issue, a quick example of how options can be used to be part of the generated message was missing, but appearing in another method doc (
added?)I didn't move the piece in
added?because it seems to be well-belonging there, but copied the example inadd