Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document mathematical notation #811

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Document mathematical notation #811

wants to merge 4 commits into from

Conversation

khaeru
Copy link
Member

@khaeru khaeru commented Mar 29, 2024

Following on the 2024-03-28 MESSAGE meeting (#388 (comment)), this PR proposes a style of mathematical notation to be used in the docs.

This style is:

  • Intended to be more explicit and easier to read and edit than the existing style.
  • Documented on a new page.
    The previous/extant style was not documented fully or in any user-visible location.

This PR is not intended to include revision of all equations to match the style, only to establish it. That revision would be accomplished in 1 or more follow-up PRs by a team of contributors.

How to review

PR checklist

  • Discuss and implement feedback.
  • Complete the section on LaTeX source.
  • Maybe expand the Sphinx LaTex/MathJax config.
    In particular, we could define LaTeX commands like \output to expand to \text{output}_{c h h^D l m n^D n^L t y^A y^V}, since these are almost always written the same way. This would make the LaTeX source of the equations much easier to read and edit.
  • Continuous integration checks all ✅
  • Add or expand tests; coverage checks both ✅
  • Add, expand, or update documentation.
  • Update release notes.

@khaeru khaeru self-assigned this Mar 29, 2024
@khaeru khaeru added enh New features & functionality docs Documentation labels Mar 29, 2024
Copy link

codecov bot commented Mar 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.4%. Comparing base (1fca82f) to head (f5f7ff6).
Report is 1 commits behind head on main.

Additional details and impacted files
@@          Coverage Diff          @@
##            main    #811   +/-   ##
=====================================
  Coverage   95.4%   95.4%           
=====================================
  Files         46      46           
  Lines       4354    4354           
=====================================
  Hits        4156    4156           
  Misses       198     198           

- Express/document different alignment of duration_time_rel.
- Correct order for "Y^A in Y".
- Reflow some text.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation enh New features & functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant