JuliaDiff / JuliaDiff/ChainRulesCore.jl
typos in geometric descriptions in the docs
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 267
- Forks
- 66
- PR merge metrics
- No merged PRs in 30d
Description
Unless I'm misunderstanding, it appears that "h" and "f" have been interchanged in the geometric description of the pushforward (Line 73 of propagators.md, specifically). If so, then that document could probably use someone knowledgeable to edit it for clarity. Even with some familiarity with differential geometry, the math is confusing. E.g. which functions are defined on what spaces.
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 propagators.md, especially line 73, and check whether h and f are interchanged in the geometric description of the pushforward. Review the surrounding mathematical notation to identify which functions are defined on which spaces. Done means correcting any notation errors and clarifying the function domains in the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100