django-salesman icon indicating copy to clipboard operation
django-salesman copied to clipboard

Add order model example to docs

Open pbadeer opened this issue 1 year ago • 2 comments

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

pbadeer avatar Feb 09 '24 13:02 pbadeer

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (8105e84) 98.17% compared to head (32a3e3b) 98.17%.

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           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Feb 09 '24 13:02 codecov[bot]

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.

pbadeer avatar Feb 09 '24 13:02 pbadeer