Update class methods to be instance methods. #3173
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
There are no class methods defined on `Spree::Order` with the names the docs suggest. These are supposed to be instance methods.
kennyadsl
reviewed
Apr 15, 2019
| @@ -137,20 +137,20 @@ If you want to retrieve the line item adjustments, you can use the | |||
| `line_item_adjustments` method: | |||
|
|
|||
| ```ruby | |||
| Spree::Order.line_item_adjustments | |||
| Spree::Order.find(1).line_item_adjustments | |||
There was a problem hiding this comment.
What about using order.line_item_adjustments. I think it should be pretty clear that it refers to an instance of the Spree::Order` class. WDYT?
There was a problem hiding this comment.
Going by the how the rest of the file is formatted I think we should take this route.
The adjustment scopes section is all formatted like this.
- `Spree::Order.find(1).adjustments.eligible`: Returns all of the eligible
adjustments on the order with ID `1`.
- `Spree::LineItem.find(1).adjustments.eligible`: Returns all of the eligible
adjustments on the line item with ID `1`.
- `Spree::Shipment.find(1).adjustments.eligible`: Returns all of the eligible
adjustments on the shipment with ID `1`.as well as part of the other adjustments docs.
Spree::Order.find(1).adjustmentsThat makes me imagine that this is probably a pattern found throughout these docs and for the sake of consistency we should follow it.
There was a problem hiding this comment.
Yes, I think we should be consistent as well, thanks for pointing that out!
kennyadsl
approved these changes
Apr 15, 2019
jacobherrington
approved these changes
Apr 15, 2019
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.
Description
There are no class methods defined on
Spree::Orderwith the names the docs suggest. These are supposed to be instance methods.