#25462: Move __unicode__ documentation and its notice after __str__
------------------------------------------------+------------------------
Reporter: charettes | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
------------------------------------------------+------------------------
In the [https://docs.djangoproject.com/en/dev/ref/models/instances/#other-
model-instance-methods other model instance methods] doc we start by
documenting by a notice about `__unicode__` vs `__str__` followed by the
actual `__unicode__` and `__str__` documentation.
Because of the way blocks are arranged it's not clear the notice is about
`__unicode__` vs `__str__` or and not ''other model instance methods'' in
general.
Since the tutorial is oriented toward Python 3 I would suggest we reorder
the doc blocks as follow:
1. `__str__`;
2. `__str__` vs `__unicode__` notice;
3. `__unicode__`.
It should make it clear the notice is about interaction of both methods
and express our preference toward Python 3.
--
Ticket URL: <https://code.djangoproject.com/ticket/25462>
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 [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/052.84b37e6d39f90b89c943957fc0df8b96%40djangoproject.com.
For more options, visit https://groups.google.com/d/optout.
