Fix inconsistent custom format documentation #438
Merged
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
Prior to this commit, the documentation for setting a custom Format was inconsistently mixing module-level and instance-level method definitions. There isn't existing precedent in the documentation for how to declare custom formats that share behavior with first-party formats (like xml and json). Since the [test suite][] utilizes a `class`-based approach (rather than a `module`-based one), change the `Base` documentation to follow that precedent. [test suite]: https://github.com/rails/activeresource/blob/v6.2.0/test/fixtures/address.rb#L4-L15
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Prior to this commit, the documentation for setting a custom Format was inconsistently mixing module-level and instance-level method definitions.
There isn't existing precedent in the documentation for how to declare custom formats that share behavior with first-party formats (like xml and json). Since the test suite utilizes a
class-based approach (rather than amodule-based one), change theBasedocumentation to follow that precedent.