[issue40051] Dead link in help(lib2to3/idlelib/turtledemo/tkinter.sub/test_*/?)

[Irit Katriel]

Change by Irit Katriel :


--
components: +2to3 (2.x to 3.x conversion tool) -Documentation, Library (Lib)
resolution:  -> wont fix
stage: needs patch -> resolved
status: open -> closed
superseder:  -> Close 2to3 issues and list them here

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue40051] Dead link in help(lib2to3/idlelib/turtledemo/tkinter.sub/test_*/?)

[wyz23x2]

wyz23x2  added the comment:

Ping? Which of the 3 should we choose?

--
versions: +Python 3.10

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue40051] Dead link in help(lib2to3/idlelib/turtledemo/tkinter.sub/test_*/?)

[wyz23x2]

Change by wyz23x2 :


--
versions:  -Python 3.7

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue40051] Dead link in help(lib2to3/idlelib/turtledemo/tkinter.sub/test_*/?)

[wyz23x2]

wyz23x2  added the comment:

OK.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue40051] Dead link in help(lib2to3/idlelib/turtledemo/tkinter.sub/test_*/?)

[Terry J. Reedy]

Terry J. Reedy  added the comment:

Not until decision made.  And not be me until I have my development machine 
running.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue40051] Dead link in help(lib2to3/idlelib/turtledemo/tkinter.sub/test_*/?)

[wyz23x2]

wyz23x2  added the comment:

Patch?

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue40051] Dead link in help(lib2to3/idlelib/turtledemo/tkinter.sub/test_*/?)

[wyz23x2]

wyz23x2  added the comment:

My opinion:
I think No.2 makes more sense to users that visit the docs directly by 
https://docs.python.org/3.8/library/lib2to3.html; they will copy the 
"docs.python.org/version/library/modulename.html" format from other modules. 
But I also agree it's fragile.
No.3 is good too, according to me. Can use it if No.2 is too fragile.

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue40051] Dead link in help(lib2to3/idlelib/turtledemo/tkinter.sub/test_*/?)

[Terry J. Reedy]

Terry J. Reedy  added the comment:

Lib/lib2to3 is a directory with __init__.py containing
   ### empty
Unlike most python-coded modules, there is no Doc/library/lib2to3.rst and hence 
no generated lib2to3.html.  Instead, there is a 2to3.rst and 2to3.html.  In the 
module index, module xyz is usually linked to .../library/xyz.html#module-xyz.  
But lib2to3 is somewhere linked instead to .../library/2to3.html#module-lib2to3.

As implied by the changed title, this issue is not at all unique to lib2to3.  
Just as lib2to3 implements the command line app 2to3, with 2to3.rst, idlelib 
implements IDLE with idle.rst.  Turtle demo is domumented within turtle.rst.  
Most tkinter submodule have no doc other than a mention within tkinter.rst.  
These could perhaps have a # module-tkinter.xyz target added.  (I am not 
familiar with exactly how.)   But there are also the numerous test modules that 
have no doc, and the generated doc for these is less useful than the code 
itself.  

Possible solutions framed in terms of lib2to3:

1. Manual redirection: add lib2to3.rst and hence lib2to3.html with the correct 
url, possibly with additional text.  But this is not the only module documented 
within a file with another name, and would not work for things like test files 
that should not be documented.

2. Auto redirection: persuade whoever manages docs.python.org to add
a redirection for lib2to3.  Fragile.

3. Hardcode the exception in the help output generation.  The latter is 
generated by pydoc.help.  The module doc location under MODULE REFERENCE is 
generated by pydoc.Doc.getdocloc.  This function already has a couple of 
(probably obsolete) tuples of exceptions, so adding more seems OK.

The oddity is that .html is added if and only if the doc location does not 
start with 'http'.  lines 414-417.I think that this is backwards. It only works 
because docs.python.org adds missing .html, even to 
"https://docs.python.org/3.8/library/2to3#module-lib2to3;, which is why the 
bug? has not been noticed.  Note that by default, docloc starts with 
'https://', so by default, .html is omitted.

Skip, David, and Martin, you have all modified this part of the code.  Do any 
of you disagree that there is a bug?

--
components:  -2to3 (2.x to 3.x conversion tool)
nosy: +martin.panter, r.david.murray, skip.montanaro, terry.reedy
stage:  -> needs patch
title: Dead link in help(lib2to3) -> Dead link in 
help(lib2to3/idlelib/turtledemo/tkinter.sub/test_*/?)
type: performance -> behavior
versions: +Python 3.7, Python 3.9

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue40051] Dead link in help(lib2to3)

[wyz23x2]

New submission from wyz23x2 :

When typing this in shell:
>>> import lib2to3
>>> help(lib2to3)

The output contains this link:
--snip--
MODULE REFERENCE
https://docs.python.org/3.8/library/lib2to3 <--

The following documentation is automatically generated from the Python
--snip--

But when you access it, 404!
This works:
https://docs.python.org/3.8/library/2to3.html#module-lib2to3

Please change it. Thanks!

--
assignee: docs@python
components: 2to3 (2.x to 3.x conversion tool), Documentation, Library (Lib)
messages: 364917
nosy: docs@python, wyz23x2
priority: normal
severity: normal
status: open
title: Dead link in help(lib2to3)
type: performance
versions: Python 3.8

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com