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

Small Tov documentation typos #5719

Merged
merged 1 commit into from
Jan 27, 2024

Conversation

pajkosmi
Copy link
Contributor

@pajkosmi pajkosmi commented Jan 25, 2024

Proposed changes

In the TovStar documentation, this PR fixes an exponent for the expression of the radial metric potential (see Eq. 26.37 of Thorne & Blandford) and the expression of the spatial metric in Cartesian coordinates in terms of the angular metric potential, to match the calculations in TovStar.cpp.

Upgrade instructions

Code review checklist

  • The code is documented and the documentation renders correctly. Run
    make doc to generate the documentation locally into BUILD_DIR/docs/html.
    Then open index.html.
  • The code follows the stylistic and code quality guidelines listed in the
    code review guide.
  • The PR lists upgrade instructions and is labeled bugfix or
    new feature if appropriate.

Further comments

@pajkosmi pajkosmi added documentation small Only changes a few lines of code, does a rename or is otherwise quick to review bugfix labels Jan 25, 2024
@nilsdeppe nilsdeppe merged commit 2112bf2 into sxs-collaboration:develop Jan 27, 2024
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bugfix documentation small Only changes a few lines of code, does a rename or is otherwise quick to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants