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

Already on GitHub? Sign in to your account

Documentation style suggestion #1776

Closed
hitalex opened this Issue Feb 22, 2013 · 4 comments

Comments

Projects
None yet
4 participants

hitalex commented Feb 22, 2013

If a module or a class contains many (member)functions, it is very hard to find a certain function on the documentation page. If I am going to find a function name, I use ctrl+f on Chrome, and threre are too many mathes.
For example, the pyplot module: http://matplotlib.org/api/pyplot_api.html#pyplot
I would suggest that there should be a function and class index on the right of the page, so one can scan through them very quickly.

Member

pelson commented Feb 22, 2013

Thanks for the suggestion @hitalex.

@NelleV has just had a pull request merged which adds numpydoc style formatting to our class documentation (#1665). The screenshot suggests that the new documentation will have a summary of all the methods (documented and undocumented) at the beginning of the class definition. Is that the kind of thing you had in mind?

hitalex commented Feb 22, 2013

To @pelson ,
Thanks for replying me so quickly.
The screenshot that @NelleV has provided looks much more prettier than I thought. I just prefer a summary of all the member functions and classes.

Owner

mdboom commented Feb 26, 2013

@hitalex -- since MEP10 is underway, which should address this, and in the interests of keeping the issue tracker clean, I'm going to close this bug as a duplicate, but feel free to reopen if you think somehow MEP10 (once completed) would not address your concern. Thanks for the feedback!

@mdboom mdboom closed this Feb 26, 2013

Member

dmcdougall commented Mar 23, 2013

Yes! This is exactly the feedback that keeps open source projects healthy. Thank you very much, @hitalex.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment