JuliaDiff / JuliaDiff/ChainRulesCore.jl

Use physics package for simpler equations

Open
#288 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Julia
Stars
267
Forks
66
PR merge metrics
No merged PRs in 30d

Description

As suggested by @simeonschaub in https://github.com/JuliaDiff/ChainRulesCore.jl/pull/200#issuecomment-668902533, we could use the macros in the physics package, bundled with MathJax 3, to have simpler math expressions. If there are no objections, I'd like to do this.

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

Locate the documentation's MathJax 3 configuration and the equations it renders, then check how the physics package macros could simplify those expressions. Confirm the result by building or previewing the documentation and verifying that the affected equations render correctly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.