Document chunk size more precisely
Open
Beginner friendly
Nobody has claimed this yet.
documentation
- Dominant language
- Julia
- Stars
- 70
- Forks
- 20
- Avg merge
- 5h 17m
- Merged PRs (30d)
- 7
Description
We should state in the docstring of Auto(Polyester)ForwardDiff that the expected behavior is to error when the chunk size is fixed and larger than the input length.
Related:
Contributor guide
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
Search the repository for the docstring of Auto(Polyester)ForwardDiff and read the surrounding documentation. Use the related DifferentiationInterface.jl pull request for context, then update the docstring to state that a fixed chunk size larger than the input length is expected to error. Done means the documented behavior is precise and consistent with the referenced change.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100