[Django] #20830: Bad URL in "Porting to Python 3 / Moved modules"

Django

unread,

Jul 30, 2013, 4:51:16 PM7/30/13

to django-...@googlegroups.com

#20830: Bad URL in "Porting to Python 3 / Moved modules"
-------------------------------+--------------------------
Reporter: glarrain | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: master
Severity: Normal | Keywords: six, python3
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------+--------------------------
The renderized URL is http://pythonhosted.org/six/index.html#six.moves and
should be http://pythonhosted.org/six/index.html#module-six.moves

I traced the error to lines 368 and 371 in the
[https://github.com/django/django/blob/master/docs/topics/python3.txt rst
source file] but my knowledge of reStructuredText is very limited.

Also, it seems weird to have a hyperlink with value
"django.utils.six.moves" pointing to the actual "six" documentation since
Django includes a custom version of it, albeit very similar. Perhaps it
will be clearer to have something like "six.moves <six.moves>".

--
Ticket URL: <https://code.djangoproject.com/ticket/20830>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,

Jul 31, 2013, 8:21:57 AM7/31/13

to django-...@googlegroups.com

#20830: Bad URL for six.moves in "Porting to Python 3 / Moved modules"
-------------------------------+------------------------------------

Reporter: glarrain | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: master

Severity: Normal | Resolution:
Keywords: six, 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 timo):

* cc: timograham@… (added)
* needs_better_patch: => 0
* needs_tests: => 0
* easy: 1 => 0
* needs_docs: => 0
* stage: Unreviewed => Accepted

Comment:

I think this may be a sphinx, intersphinx, or six docs issue, but I
haven't taken a deep dive to determine the root cause. As you described
above, the six docs ID that's generated is "module-six.moves" instead of
the expected "six.moves".

--
Ticket URL: <https://code.djangoproject.com/ticket/20830#comment:1>

Django

unread,

Sep 22, 2013, 7:10:26 PM9/22/13

to django-...@googlegroups.com

#20830: Bad URL for six.moves in "Porting to Python 3 / Moved modules"
-------------------------------------+-------------------------------------

Reporter: glarrain | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: master

Severity: Normal | Resolution:
Keywords: six, python3, | Triage Stage: Accepted
afraid-to-commit | Needs documentation: 0
Has patch: 0 | Patch needs improvement: 0
Needs tests: 0 | UI/UX: 0
Easy pickings: 1 |
-------------------------------------+-------------------------------------
Changes (by EvilDMP):

* cc: EvilDMP (added)
* keywords: six, python3 => six, python3, afraid-to-commit
* easy: 0 => 1

Old description:

> The renderized URL is http://pythonhosted.org/six/index.html#six.moves
> and should be http://pythonhosted.org/six/index.html#module-six.moves
>
> I traced the error to lines 368 and 371 in the
> [https://github.com/django/django/blob/master/docs/topics/python3.txt rst
> source file] but my knowledge of reStructuredText is very limited.
>
> Also, it seems weird to have a hyperlink with value
> "django.utils.six.moves" pointing to the actual "six" documentation since
> Django includes a custom version of it, albeit very similar. Perhaps it
> will be clearer to have something like "six.moves <six.moves>".

New description:

The renderized URL is http://pythonhosted.org/six/index.html#six.moves and
should be http://pythonhosted.org/six/index.html#module-six.moves

I traced the error to lines 368 and 371 in the
[https://github.com/django/django/blob/master/docs/topics/python3.txt rst
source file] but my knowledge of reStructuredText is very limited.

Also, it seems weird to have a hyperlink with value
"django.utils.six.moves" pointing to the actual "six" documentation since
Django includes a custom version of it, albeit very similar. Perhaps it
will be clearer to have something like "six.moves <six.moves>".

Marked as easy-pickings for the second issue. I'm not sure what's going on
with the first.

--

Comment:

Sphinx on my local installation also renders the links to
`http://pythonhosted.org/six/index.html#module-six.moves` and
`http://pythonhosted.org/six/index.html#module-six` incorrectly, failing
to include the `module-` part.

There's still the second issue, which we can do something about, where our
docs say:

{{{
Some modules were renamed in Python 3. The :mod:`django.utils.six.moves
<six.moves>` module provides a compatible location to import them.
}}}

In other words, we are referring to a Python module (`<six.moves>`), but
the hyperlink text (`django.utils.six.moves`) appears to refer to
something in Django, so that hyperlink text should be changed. We could
say something like:

{{{
The Python :mod:`six.moves <six.moves>` module...
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/20830#comment:2>

Django

unread,

Sep 22, 2013, 7:30:08 PM9/22/13

to django-...@googlegroups.com

#20830: Bad URL for six.moves in "Porting to Python 3 / Moved modules"
-------------------------------------+-------------------------------------

Reporter: glarrain | Owner: nobody
Type: Bug | Status: new
Component: Documentation | Version: master

Comment (by timo):

Django includes a copy of six, hence the `django.utils.six.moves`
reference. In the context of the sentence, it makes sense to reference
this location.

--
Ticket URL: <https://code.djangoproject.com/ticket/20830#comment:3>

Django

unread,

Sep 23, 2013, 6:03:04 AM9/23/13

to django-...@googlegroups.com

#20830: Bad URL for six.moves in "Porting to Python 3 / Moved modules"
-------------------------------------+-------------------------------------
Reporter: glarrain | Owner: dchetwynd
Type: Bug | Status: assigned
Component: Documentation | Version: master

Changes (by dchetwynd):

* owner: nobody => dchetwynd
* status: new => assigned

Comment:

I am fixing this bug as part of the Django development sprint at PyCon UK
2013.

--
Ticket URL: <https://code.djangoproject.com/ticket/20830#comment:4>

Django

unread,

Sep 23, 2013, 6:28:45 AM9/23/13

to django-...@googlegroups.com

#20830: Bad URL for six.moves in "Porting to Python 3 / Moved modules"
-------------------------------------+-------------------------------------
Reporter: glarrain | Owner: dchetwynd
Type: Bug | Status: assigned

Component: Documentation | Version: master

Comment (by dchetwynd):

I've just rendered this page myself with Sphinx using Firefox 23.0.1 and
Sphinx version 1.2b2 on Fedora 19. The link in question does render
correctly in my browser as http://pythonhosted.org/six/index.html#module-
six.moves, so the "module-" prefix of the link anchor is not omitted,
unlike on EvilDMP's system. This may therefore only be an issue with some
versions of Sphinx.

--
Ticket URL: <https://code.djangoproject.com/ticket/20830#comment:5>

Django

unread,

Sep 23, 2013, 7:13:33 AM9/23/13

to django-...@googlegroups.com

#20830: Bad URL for six.moves in "Porting to Python 3 / Moved modules"
-------------------------------------+-------------------------------------
Reporter: glarrain | Owner: dchetwynd
Type: Bug | Status: assigned

Component: Documentation | Version: master

Comment (by dchetwynd):

In relation to the second issue on links to the six module, there are
inconsistencies between links to the Python version of six and links to
the Django version of six. In the /topics/python3.html documentation page
are seven links to the six module. Four of these links are correct, but
the following three links are to the Python version of six, instead of the
Django version:

1) The "six" link in the third sentence of the "Writing compatible code
with six" section
2) The "django.utils.six" link in the fourth sentence of the "Writing
compatible code with six" section
3) The "six" link in the final sentence of the "PY2" section

I will therefore change these three links to the correct targets.

--
Ticket URL: <https://code.djangoproject.com/ticket/20830#comment:6>

Django

unread,

Sep 23, 2013, 7:19:16 AM9/23/13

to django-...@googlegroups.com

#20830: Bad URL for six.moves in "Porting to Python 3 / Moved modules"
-------------------------------------+-------------------------------------
Reporter: glarrain | Owner: dchetwynd
Type: Bug | Status: assigned

Component: Documentation | Version: master

Comment (by EvilDMP):

I don't think it's necessarily incorrect to link to the Python version of
the docs, but it is certainly confusing to link to them with link text
that suggests we're speaking of Django docs. So I think it's worth noting
that documentation for (nearly all you need to know about) Django's
version (rather than 'copy') of six can in fact be found in the Python
documentation. More clarification rather than correction perhaps.

--
Ticket URL: <https://code.djangoproject.com/ticket/20830#comment:7>

Django

unread,

Sep 23, 2013, 7:55:50 AM9/23/13

to django-...@googlegroups.com

#20830: Bad URL for six.moves in "Porting to Python 3 / Moved modules"
-------------------------------------+-------------------------------------
Reporter: glarrain | Owner: dchetwynd
Type: Bug | Status: assigned

Component: Documentation | Version: master

Comment (by timo):

Yes, I agree to keep the links are they are and add clarification if
needed.

I also confirm that the linking issue is fixed with Sphinx 1.2b2 which
docs.djangoproject.com is now using.

--
Ticket URL: <https://code.djangoproject.com/ticket/20830#comment:8>

Django

unread,

Sep 23, 2013, 10:48:49 AM9/23/13

to django-...@googlegroups.com

#20830: Bad URL for six.moves in "Porting to Python 3 / Moved modules"
-------------------------------------+-------------------------------------
Reporter: glarrain | Owner: dchetwynd
Type: Bug | Status: assigned

Component: Documentation | Version: master

Comment (by dchetwynd):

I have submitted a pull request for this ticket fix.

As per timo's confirmation that the linking issue is fixed in Sphinx
1.2b2, I have not changed this. I have modified a few of the link targets,
added a couple of extra sentences to clarify that Django uses a customised
version of the six module and changed a section header.

--
Ticket URL: <https://code.djangoproject.com/ticket/20830#comment:9>

Django

unread,

Sep 23, 2013, 11:04:45 AM9/23/13

to django-...@googlegroups.com

#20830: Bad URL for six.moves in "Porting to Python 3 / Moved modules"
-------------------------------------+-------------------------------------
Reporter: glarrain | Owner: dchetwynd

Type: Bug | Status: closed
Component: Documentation | Version: master
Severity: Normal | Resolution: fixed

Changes (by Tim Graham <timograham@…>):

* status: assigned => closed
* resolution: => fixed

Comment:

In [changeset:"a53caf28bf2ab29cf4e78a968b3887ddb6d6e83d"]:
{{{
#!CommitTicketReference repository=""
revision="a53caf28bf2ab29cf4e78a968b3887ddb6d6e83d"
Fixed #20830 -- Clarified that Django uses a customized version of six.

Thanks glarrain for the suggestion.
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/20830#comment:10>

Django

unread,

Sep 23, 2013, 11:07:51 AM9/23/13

to django-...@googlegroups.com

#20830: Bad URL for six.moves in "Porting to Python 3 / Moved modules"
-------------------------------------+-------------------------------------
Reporter: glarrain | Owner: dchetwynd
Type: Bug | Status: closed

Component: Documentation | Version: master

Comment (by Tim Graham <timograham@…>):

In [changeset:"5e549e7efe7fc5b29124846278a6b30332e40dc4"]:
{{{
#!CommitTicketReference repository=""
revision="5e549e7efe7fc5b29124846278a6b30332e40dc4"
[1.6.x] Fixed #20830 -- Clarified that Django uses a customized version of
six.

Thanks glarrain for the suggestion.

Backport of a53caf28bf from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/20830#comment:12>

Django

unread,

Sep 23, 2013, 11:07:50 AM9/23/13

to django-...@googlegroups.com

#20830: Bad URL for six.moves in "Porting to Python 3 / Moved modules"
-------------------------------------+-------------------------------------
Reporter: glarrain | Owner: dchetwynd
Type: Bug | Status: closed

Component: Documentation | Version: master

Comment (by Tim Graham <timograham@…>):

In [changeset:"c695f293e3ce74657268e532ee69ae64c92bfa1c"]:
{{{
#!CommitTicketReference repository=""
revision="c695f293e3ce74657268e532ee69ae64c92bfa1c"
[1.5.x] Fixed #20830 -- Clarified that Django uses a customized version of
six.