Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor updates in promotions overview documentation #3121

Merged
merged 2 commits into from
Feb 25, 2019
Merged

Minor updates in promotions overview documentation #3121

merged 2 commits into from
Feb 25, 2019

Conversation

JuanCrg90
Copy link
Contributor

@JuanCrg90 JuanCrg90 commented Feb 22, 2019

Description
This pull request adds some minor updates in the promotions documentation.

  • Add Adjustments documentation link on Promotions overview
  • remove eligible? method line number

Checklist:

  • I have followed Pull Request guidelines
  • I have added a detailed description into each commit message
  • I have updated Guides and README accordingly to this change (if needed)
  • I have added tests to cover this change (if needed)

@JuanCrg90 JuanCrg90 changed the title Add adjustments docs link on promotions overview minor updates in promotions overview documentation Feb 22, 2019
@JuanCrg90 JuanCrg90 changed the title minor updates in promotions overview documentation Minor updates in promotions overview documentation Feb 22, 2019
Copy link
Member

@kennyadsl kennyadsl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a comment/question but it's not blocking. Thanks!

@@ -140,7 +138,7 @@ See the `eligible?` method defined in the [Spree::Promotion
model][spree-promotion]:

```ruby
# models/spree/promotion.rb : line 123
# models/spree/promotion.rb : line 120
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure it's a good idea to keep this line number. It's very hard to maintain and it's super easy to find a method into a file with all editors or browsers. Not sure if it's better to take advantage of this change to remove it or we could remove it also in other places (if any) with another PR. WDYT?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated Thanks for the suggestion 😄

The promotions documentation `def eligible?` method line number is
unnecessary this updates the documentation reference removing the
line number.
Copy link
Contributor

@jacobherrington jacobherrington left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thanks @JuanCrg90! 🏅

@jacobherrington
Copy link
Contributor

Re-running build to get ✅

@jacobherrington jacobherrington merged commit 7665973 into solidusio:master Feb 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants