JuliaDiff / JuliaDiff/DiffResults.jl
Document why re-aliasing is important
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 37
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
The documentation points out, that it really important to re-alias the result, e.g. in
result = ForwardDiff.hessian!(result, f, x);
It says that more information for why this is done can be found in the documentation of ForwardDiff.hessian!. Unfortunately, the according documentation does not talk about DiffResults at all so I remain curious why re-aliasing is necessary here. Is re-aliasing no longer needed?
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 by reading the documentation that mentions re-aliasing and the documentation for ForwardDiff.hessian!, then inspect the DiffResults API referenced by the example. Clarify whether re-aliasing result is still required and document why, or update the example and explanation if it is no longer necessary.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100