clarify ChainRulesCore.jl integration

Open
  • Is something wrong?
#36 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
julia
Domain
documentation

Research direction

Read the README and identify the section describing supported functions or contributions. Clarify that all functions have forward and reverse rules implemented through ChainRulesCore.jl, and that pull requests should implement and test those rules. Done means both points are explicit in the README.

Written by the indexing model from the issue text.

Description

The README should make it clear that

  1. all functions have working forward- and reverse rules, implemented via ChainRulesCore.jl

  2. pull requests should implement and test these, too

Dominant language
Julia
Stars
86
Forks
25
Avg merge
4d 7h
Merged PRs (30d)
3

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from JuliaStats/LogExpFunctions.jl

All issues in JuliaStats/LogExpFunctions.jl

Similar issues

More Julia issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.