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.

Sign up for GitHub

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

Jump to bottom

Docs: missing brief class descriptions #587

Open
jpnurmi opened this issue Feb 5, 2023 · 0 comments
Open

Docs: missing brief class descriptions #587

jpnurmi opened this issue Feb 5, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@jpnurmi
Copy link
Member

jpnurmi commented Feb 5, 2023

Split off from #280.

Many classes don't have any class-level description. It's arguably the most important part of the docs to give a short summary of what each class does. Preferably, with a short and concise code snippet to get started.

Overview Class
image image
@jpnurmi jpnurmi mentioned this issue Feb 5, 2023
Closed
12 tasks
@Feichtmeier Feichtmeier added the documentation Improvements or additions to documentation label Mar 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jpnurmi @Feichtmeier