NWChemEx / NWChemEx/PluginPlay
Add notes on writing module descriptions
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 13
- Forks
- 1
- Avg merge
- 43m
- Merged PRs (30d)
- 4
Description
As the title suggests we should add some documentation on best practices for writing module descriptions
- use C++ string blocks
R"""(<description goes here>)""" - content should be Sphinx-flavored reST
- can use math (link to https://nwchemex-project.github.io/DeveloperTools/resources/rest_cheatsheet.html)
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 locating the existing documentation for module descriptions in the PluginPlay repository. Add guidance covering C++ raw string blocks, Sphinx-flavored reST, and math, including the referenced reST cheatsheet; the work is done when these best practices are documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100