[docs] [issue10858] Make source code links less prominent

Alexander Belopolsky report at bugs.python.org
Fri Jan 7 22:52:01 CET 2011

Alexander Belopolsky <belopolsky at users.sourceforge.net> added the comment:

On Fri, Jan 7, 2011 at 4:32 PM, Éric Araujo <report at bugs.python.org> wrote:
> 3: Not all modules are good examples (see threading for some unelegant code), so I support ad-hoc selection.

The problem with ad-hoc selection is that it adds maintenance burden
(someone has to make a call) and it is inherently subjective.  For
example, I find dis.py source code rather uninspiring while
pickletools.py has a trove of valuable information about pickle
opcodes that is not available elsewhere.

>  I also support the real fix of improving the quality of every module, but that’s longer-term. :)

Having the sources on "public display" may help achieving this goal.

> 4: “Show Source” is a link that is easily overlooked IMO, a seealso section makes me think people
> will actually see the link.

A side-bar link may be in addition to the more prominent but less
common "See also" links.  If the source navigation becomes available,
we can also add inconspicuous links to function sectoins that would
take you directly to the function source code.


Python tracker <report at bugs.python.org>

More information about the docs mailing list