JuliaDiff / JuliaDiff/ChainRulesCore.jl
Write better docs on what types a pullback should accept.
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Julia
- Stars
- 267
- Forks
- 66
- PR merge metrics
- No merged PRs in 30d
Description
Needs to include explaining that it must accept AbstractThunk (a requirement of CRC 1.0)
Also should be the place we talk about ProjectTo
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
Locate the existing documentation for pullbacks and read how accepted types are currently described. Update it to explain the AbstractThunk requirement from CRC 1.0 and make it the place where ProjectTo is discussed; done means both topics are covered clearly in the relevant 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
- 45/100