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

Update API structure #214

Open
valeriof7 opened this issue Jan 22, 2025 · 0 comments
Open

Update API structure #214

valeriof7 opened this issue Jan 22, 2025 · 0 comments

Comments

@valeriof7
Copy link
Contributor

I have a suggestion to make it much easier to read: Now we have tables for each module (see first images) as well as full function descriptions (see second image) on the same web page. I would instead use sub-pages, starting with a table of objects and then a separate page for each object with the associated attributes and methods. See matplotlib API for example.

Image
Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

1 participant