DOC: check equations and notation in section Methods and Algorithms of the user documentation
Open
Nobody has claimed this yet.
cleanup
difficulty: medium
documentation
enhancement
- Dominant language
- C++
- Stars
- 2
- Forks
- 1
- Avg merge
- 7h 35m
- Merged PRs (30d)
- 13
Description
For instance, does $x^\prime$ represents the transposed vector $x$ ?
Many matrices are not defined.
Some equations seem wrong.
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 Methods and Algorithms section of the user documentation. Review the meaning of x′, define every matrix, and verify the equations against the surrounding text and model context. Done means the notation is explicit and the suspected equation errors are corrected or documented.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 48/100