#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 <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 post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/066.99f8680f12aa091982ab546ac8c56893%40djangoproject.com.
For more options, visit https://groups.google.com/groups/opt_out.
