You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
@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?
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.
@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!
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.
The text was updated successfully, but these errors were encountered: