code documentation
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 236
- Forks
- 47
- PR merge metrics
- No merged PRs in 30d
Description
Is the code documentation at
https://software.llnl.gov/libROM/html/index.html
a little behind the current version of libROM?
For instance I cannot seem to find: "SampleMeshManager" in the documentation.
Nachiket
Contributor guide
No contributing guide indexed for this repository
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 comparing the current libROM code with the generated documentation at https://software.llnl.gov/libROM/html/index.html, checking whether SampleMeshManager and other current interfaces are missing. Done means identifying the documentation mismatch and updating the relevant generated or source documentation, but the issue does not name a file or test.
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
- Needs clarification
- Newbie friendliness
- 25/100