JuliaDiff / JuliaDiff/FiniteDiff.jl
Document kwargs and fix missing uses
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 304
- Forks
- 42
- Avg merge
- 24m
- Merged PRs (30d)
- 2
Description
The kwargs absstep, relstep and dir are not uniformly documented. And there might even be cases where one kwarg is forgotten, i.e. here (dir is missing). Now that DI has to use them, it would be nice if someone could explain what they do and check that they are properly passed around?
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
Inspect src/gradients.jl lines 183-194, then search the package for absstep, relstep, and dir to compare their documentation and propagation. Done means the kwargs are consistently explained and passed wherever they are required, including the linked gradients.jl case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- backend-api-design, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100