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

Improve main module/package descriptions #105

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

Improve main module/package descriptions #105

gilrrei opened this issue Jan 22, 2025 · 0 comments
Labels
status: open No solution for this issue has been provided topic: documentation Issue/PR realted to the documentation type: usability Issue/PR to improve usability

Comments

@gilrrei
Copy link
Contributor

gilrrei commented Jan 22, 2025

Description of the Issue:

Currently, the main module and package descriptions are a bit hard to understand, as highlighted in #98. It is important to improve those as they are being used in the HTML documentation as well.

Proposed Solution:

Elaborate reasonable module/package descriptions in a developer meeting

Action Items:

No response

Related Issues:

No response

Interested Parties:

No response
@gilrrei gilrrei added status: open No solution for this issue has been provided topic: documentation Issue/PR realted to the documentation type: usability Issue/PR to improve usability labels Jan 22, 2025
@gilrrei gilrrei mentioned this issue Jan 22, 2025
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
status: open No solution for this issue has been provided topic: documentation Issue/PR realted to the documentation type: usability Issue/PR to improve usability
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gilrrei