NWChemEx / NWChemEx/PluginPlay
Module Docs Should Have Default Key
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 13
- Forks
- 1
- Avg merge
- 43m
- Merged PRs (30d)
- 4
Description
AFAIK the module documentation is generated by looping over a ModuleManager instance. This means the routine for creating the documentation should also be able to update the documentation with what the default key is for the module, e.g., in ChemCache it would be great if the documentation page for the NWXMolecule module said the key was "NWX Molecules".
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing how module documentation is generated while looping over a ModuleManager instance, then compare the generated NWXMolecule documentation page in ChemCache. The work is done when the module's default key, such as "NWX Molecules", appears in its generated documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100