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

Improved documentation for coreComponents packages #3292

Open
paloma-martinez opened this issue Aug 21, 2024 · 0 comments
Open

Improved documentation for coreComponents packages #3292

paloma-martinez opened this issue Aug 21, 2024 · 0 comments
Labels
type: documentation type: new A new issue has been created and requires attention

Comments

@paloma-martinez
Copy link
Contributor

What needs to be documented?
Many coreComponents packages such as codingUtilities, common, etc.. seems to not be documented on what they contain, manage, should not contain. As a developper, it is currently not obvious the responsibilities of some of these packages.

What sort of documentation would help?
DevGuide doc.

What are the deficiencies of the existing documentation?
The files and classes are documented but the containing packages lack description.

Additional notes or context
In addition, it might be very useful to have a small documentation at the top of each CMakeLists.txt file such that brief info about the package is accessible easily, especially while making modification in the package.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation type: new A new issue has been created and requires attention
Projects
None yet
Development

No branches or pull requests

1 participant