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

docs: add metric and transformation conventions #568

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

Conversation

Saransh-cpp
Copy link
Member

@Saransh-cpp Saransh-cpp commented Mar 9, 2025

Description

Add metric, transformation and boost, and Euler angle conventions followed by vector (aligned with the ones followed in ROOT and GenVector).

See openjournals/joss-reviews#7791 (comment)

Checklist

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't any other open Pull Requests for the required change?
  • Does your submission pass pre-commit? ($ pre-commit run --all-files or $ nox -s lint)
  • Does your submission pass tests? ($ pytest or $ nox -s tests)
  • Does the documentation build with your changes? ($ cd docs; make clean; make html or $ nox -s docs)
  • Does your submission pass the doctests? ($ pytest --doctest-plus src/vector/ or $ nox -s doctests)

Before Merging

  • Summarize the commit messages into a brief review of the Pull request.

@Saransh-cpp Saransh-cpp added the docs Improvements or additions to documentation label Mar 9, 2025
@Saransh-cpp Saransh-cpp self-assigned this Mar 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant