#31541: Improve documentation of django.contrib.redirects.
-------------------------------------+-------------------------------------
Reporter: Adam (Chainz) | Owner: nobody
Johnson |
Type: | Status: new
Cleanup/optimization |
Component: contrib.redirects | Version: master
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by felixxm):
* stage: Unreviewed => Accepted
Old 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_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://
New 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_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://
--
--
Ticket URL: <https://code.djangoproject.com/ticket/31541#comment:2>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to django-updates+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/068.9020f3b3773972761fcc05116e1637d9%40djangoproject.com.
