Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reason for no module internal link? #39

Open
Hibou57 opened this issue Mar 12, 2015 · 1 comment

Comments

Projects
None yet
1 participant
@Hibou57
Copy link
Contributor

commented Mar 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.mako to 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).

@Hibou57

This comment has been minimized.

Copy link
Contributor Author

commented Mar 12, 2015

With my patched html.mako and css.mako I can display reference to function parameters, as <span class="arg"><code>fn-arg</code></span> instead of as <code>fn-arg</code>. It requires to pass a context parameter around. It's handled in linkify although it does not generate a link.

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
You can’t perform that action at this time.