rennerocha commented 3 years ago

After installing the package in my project, I noticed that the examples of how to configure the URLs are not entirely correct. So I did some minor changes that would make the life of a newcomer easier:

Replace deprecated url function with path (as we don't have a regex to be handled). Besides the fact that current code works, in my opinion it would be good if the documentation matches the good practices of the latest supported version of Django;
Replace text url with URL, given that URL is an acronym to Uniform Resource Locator;
Fix endpoints that are available given the configuration provided in the examples.

codecov-commenter commented 3 years ago

Codecov Report

Merging #127 (e3f5c6d) into master (c98371c) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #127   +/-   ##
=======================================
  Coverage   91.70%   91.70%           
=======================================
  Files          11       11           
  Lines         241      241           
=======================================
  Hits          221      221           
  Misses         20       20

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update c98371c...e3f5c6d. Read the comment docs.

nezhar commented 3 years ago

Thanks :+1:

anexia-it / django-rest-passwordreset

Improvement on endpoints provided documentation #127

Codecov Report