Opened 4 years ago

Last modified 4 years ago

#31541 closed Cleanup/optimization

Improve documentation of django.contrib.redirects. — at Version 2

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 (last modified by Mariusz Felisiak)

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_path field's help_text states full URL starting with “http://””. This doesn't mention the now-more-common https://, nor the fact that arbitrary protocols are technically supported, such as onion://. Perhaps full URL starting with a scheme such as ​https://

Change History (2)

comment:1 by Mark Dawson, 4 years ago

I'd be happy to try to improve some of these docs unless you wanted to do that @adam

Last edited 4 years ago by Mark Dawson (previous) (diff)

comment:2 by Mariusz Felisiak, 4 years ago

Description: modified (diff)
Summary: Improve documentation of django.contrib.redirects → Improve documentation of django.contrib.redirects.
Triage Stage: Unreviewed → Accepted
Note: See TracTickets for help on using tickets.
Back to Top