FluxML/Zygote.jl

Exported methods without docstring

Open

#1,411 opened on Apr 8, 2023

View on GitHub
 (0 comments) (2 reactions) (0 assignees)Julia (220 forks)batch import
good first issuehelp wanted

Repository metrics

Stars
 (1,568 stars)
PR merge metrics
 (Avg merge 2d 16h) (39 merged PRs in 30d)

Description

The following exported methods don't have a docstring:

  • pullback
  • pushforward
  • @code_adjoint

Contributor guide

Research direction
Look at existing docstrings in the Zygote codebase for style and write docstrings for `pullback`, `pushforward`, and `@code adjoint` following the same format.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJulia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85