JuliaDiff / JuliaDiff/ForwardDiff.jl

Document internals?

Open
#682 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
1k
Forks
160
PR merge metrics
No merged PRs in 30d

Description

Is there a reason why types like Dual and Tag or functions like value and derivative are left undocumented?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation and source definitions for Dual, Tag, value, and derivative. Check how these symbols are presented in existing ForwardDiff.jl docs and determine which are intended for users; done means the documentation scope and treatment of these internals are resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.