The docs for the braid example are misleading
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 248
- Forks
- 72
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 15
Description
The [docs for the braid example](https://llnl-conduit.readthedocs.io/en/latest/blueprint_mesh.html#braid) currently say "nx, ny, nz specify the number of **elements** in the x, y, and z directions" when in reality, the actual behavior seems to be "nx, ny, nz specify the number of **points** in the x, y, and z directions".
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 with the linked braid section in the Blueprint Mesh documentation and compare its description with the stated behavior of nx, ny, and nz. Update the wording so it says these values specify the number of points in each direction, then verify the rendered documentation reflects the correction.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 85/100