code documentation

Open
#188 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
cpp
Domain
documentation

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.

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

Dominant language
C++
Stars
236
Forks
47
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from llnl/libROM

All issues in llnl/libROM

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.