Opened 12 years ago
Last modified 12 years ago
#20830 closed Bug
Bad URL for six.moves in "Porting to Python 3 / Moved modules" — at Version 2
| Reported by: | German Larrain | Owned by: | nobody | 
|---|---|---|---|
| Component: | Documentation | Version: | dev | 
| Severity: | Normal | Keywords: | six, python3, afraid-to-commit | 
| Cc: | timograham@…, Daniele Procida | Triage Stage: | Accepted | 
| Has patch: | no | Needs documentation: | no | 
| Needs tests: | no | Patch needs improvement: | no | 
| Easy pickings: | yes | UI/UX: | no | 
Description (last modified by )
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 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.
Change History (2)
comment:1 by , 12 years ago
| Cc: | added | 
|---|---|
| Easy pickings: | unset | 
| Summary: | Bad URL in "Porting to Python 3 / Moved modules" → Bad URL for six.moves in "Porting to Python 3 / Moved modules" | 
| Triage Stage: | Unreviewed → Accepted | 
comment:2 by , 12 years ago
| Cc: | added | 
|---|---|
| Description: | modified (diff) | 
| Easy pickings: | set | 
| Keywords: | afraid-to-commit added | 
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...
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".