Opened 6 years ago
Last modified 5 years ago
#31541 closed Cleanup/optimization
Improve documentation of django.contrib.redirects — at Initial Version
| Reported by: | Adam Johnson | Owned by: | nobody |
|---|---|---|---|
| Component: | contrib.redirects | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Ready for checkin | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | yes | UI/UX: | no |
Description
I think there are a couple small improvements that could be made to the docs here:
- The "Via the Python API" section could do with a simple shell example for creating a
Redirect, since otherwise the fields aren't mentioned in the docs. I also imagine it might be used by relatively new users who aren't confident with the ORM. - The
Redirect.new_pathfield'shelp_textstatesfull URL starting with “http://””. This doesn't mention the now-more-commonhttps://, nor the fact that arbitrary protocols are technically supported, such asonion://. Perhaps `full URL starting with a scheme such as "https://
Note:
See TracTickets
for help on using tickets.