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

Add order model example to docs #37

Closed
wants to merge 2 commits into from
Closed

Conversation

pbadeer
Copy link
Contributor

@pbadeer pbadeer commented Feb 9, 2024

Currently the "Checkout and Payment" documentation page has an example payment.py that does not work if you follow the guide, because the guide never has you set up the custom Order model that it's using behind the scenes.

Thank you for contributing to Salesman, before you continue make sure that:

  • Tests still pass: poetry run pytest
  • There are no lint errors: poetry run pre-commit run --all-files

Currently the "Checkout and Payment" documentation page has an example payment.py that does not work if you follow the guide, because the guide never has you set up the custom Order model that it's using behind the scenes.
Copy link

codecov bot commented Feb 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.17%. Comparing base (8105e84) to head (32a3e3b).
Report is 6 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master      #37   +/-   ##
=======================================
  Coverage   98.17%   98.17%           
=======================================
  Files          49       49           
  Lines        2032     2032           
=======================================
  Hits         1995     1995           
  Misses         37       37           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@pbadeer
Copy link
Contributor Author

pbadeer commented Feb 9, 2024

I saw where the orders.py file was being surfaced in the docs and I've corrected my documentation changes to reference your existing pattern of using swappable models.

@dinoperovic
Copy link
Owner

Hi @pbadeer, thanks but I dont thinks this should be added in the "Checkout and payment" section, as it relates to setting up the projects. This is why its mentioned in the "Installation" section instead.

Setting up of custom swappable models is optional, so I would not write it as a required step here, the example payment.py should instead not assume swappable model is used.

I will update the advance.py example file to not assume that.

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.

2 participants