[Django] #20224: Documentation fix of allow_lazy usage example
Django
--------------------------------------+--------------------
Reporter: void | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+--------------------
There is a line in the usage example of `allow_lazy`:
`fancy_utility_function = allow_lazy(fancy_utility_function, unicode)`
It would be better to use `six.text_type` instead of `unicode`, because
`unicode` does not exist of python3
--
Ticket URL: <https://code.djangoproject.com/ticket/20224>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
Django
Reporter: void | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Keywords: python3 | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
Changes (by bmispelon):
* cc: bmispelon@… (added)
* needs_better_patch: => 0
* needs_tests: => 0
* keywords: => python3
* needs_docs: => 0
* stage: Unreviewed => Accepted
Comment:
There's a lot of places in the documentation with code examples that don't
work in python3 (see #19841 for example).
I think we need to decide what to do about it in general.
From what I understand, the current position is that python3 support is
"experimental", so the documentation stays python2-oriented. This will
surely change at some point, and probably soon.
--
Ticket URL: <https://code.djangoproject.com/ticket/20224#comment:1>
Django
Reporter: void | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Keywords: python3 | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by claudep):
Python 3 support will not be called experimental in 1.6, so yes, a fix is
welcome here. However, I'm not sure if always using `six` is a good idea.
It's the right thing to do to support both Python 2 and Python 3, but most
users will probably target either one or the other. An alternative could
be adding a str/unicode note somewhere in the docs and refer to that note
each time we are using `unicode` in examples.
--
Ticket URL: <https://code.djangoproject.com/ticket/20224#comment:2>
Django
Reporter: void | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Keywords: python3 | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Easy pickings: 0 | UI/UX: 0
Comment (by bmispelon):
For what it's worth, I'm +1 on claudep's proposal.
--
Ticket URL: <https://code.djangoproject.com/ticket/20224#comment:3>
Django
--------------------------------------+------------------------------------
Reporter: void | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Keywords: python3 | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
--------------------------------------+------------------------------------
Changes (by timo):
* easy: 0 => 1
--
Ticket URL: <https://code.djangoproject.com/ticket/20224#comment:4>
Django
--------------------------------------+------------------------------------
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: master
Keywords: python3 | Triage Stage: Accepted
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+------------------------------------
* has_patch: 0 => 1
Comment:
https://github.com/django/django/pull/1330
--
Ticket URL: <https://code.djangoproject.com/ticket/20224#comment:5>
Django
Reporter: void | Owner: nobody
Type: | Status: new
Cleanup/optimization | Version: master
Component: Documentation | Resolution:
Severity: Normal | Triage Stage: Ready for
Keywords: python3 | checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
Changes (by timo):
* stage: Accepted => Ready for checkin
Comment:
Left minor comments on the PR, should be good to go without another review
though, thanks!
--
Ticket URL: <https://code.djangoproject.com/ticket/20224#comment:6>
Django
-------------------------------------+-------------------------------------
Type: | Status: closed
Cleanup/optimization | Version: master
Component: Documentation | Resolution: fixed
Severity: Normal | Triage Stage: Ready for
Keywords: python3 | checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
* status: new => closed
* resolution: => fixed
Comment:
In [changeset:"7442eb1a242ecf9d186d4e7de1b94e360e04782d"]:
{{{
#!CommitTicketReference repository=""
revision="7442eb1a242ecf9d186d4e7de1b94e360e04782d"
Fixed #20224 -- Update docs examples which mention __unicode__
Thanks Marc Tamlyn and Tim Graham for the review.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/20224#comment:7>
Django
-------------------------------------+-------------------------------------
Type: | Status: closed
Cleanup/optimization | Version: master
Component: Documentation | Resolution: fixed
Severity: Normal | Triage Stage: Ready for
Keywords: python3 | checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Claude Paroz <claude@…>):
In [changeset:"a9dd6221af2148410c8a26dcbafd1ff8cc0fb107"]:
{{{
#!CommitTicketReference repository=""
revision="a9dd6221af2148410c8a26dcbafd1ff8cc0fb107"
[1.6.x] Fixed #20224 -- Update docs examples which mention __unicode__
Thanks Marc Tamlyn and Tim Graham for the review.
Backport of 7442eb1a24 from master.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/20224#comment:8>