Fix bulk modulus formula in API documentation
Open
Nobody has claimed this yet.
documentation
good first issue
- Dominant language
- C++
- Stars
- 39
- Forks
- 22
- Avg merge
- 10h 22m
- Merged PRs (30d)
- 3
Description
There is a missing density in the formula for the bulk modulus.
Also we should add that the units for the bulk modulus are pressure since mass * length^2 / time^2 isn't an obvious pressure unit.
Thanks to @c0sm0-kramer for pointing it out
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
Open the linked API documentation entry for BulkModulusFromDensityTemperature and inspect its displayed formula and units. Correct the missing density and state that bulk modulus is measured in pressure units; done means the rendered documentation clearly shows both corrections.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100