Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.
Sign upReason for no module internal link? #39
Comments
This comment has been minimized.
This comment has been minimized.
|
With my patched I will wait an answer to the question before I propose this patch (for two things: internal module links and distinguished display of reference to function parameters in function documentation strings). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hibou57 commentedMar 12, 2015
I would like to know about the reason for not having module internal links in the generated documentation. My guess is that is may not always be easy, when as an example, a documentation string refers to a function parameter which is of the same name as an item defined in the module (PyLint warns about it, by the way).
Is this guess indeed the reason or is there another reason?
I “patched” my
html.makoto display internal links, and am asking this question to know if it's relevant to propose this patch here.I'm also actually to display references to function parameters in function documentation strings, with a specific class (I mean, HTML class), if feasible (under investigation).