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: Improve documentation #233

Merged
merged 9 commits into from
Jul 2, 2023
Merged

docs: Improve documentation #233

merged 9 commits into from
Jul 2, 2023

Conversation

chrispap95
Copy link
Collaborator

@chrispap95 chrispap95 commented Jun 27, 2023

Let's improve the documentation and close the open issues.

Changelog:

  • I improved the algorithm description section. I used LaTeX for the formulas and added all the missing distance measures.
  • I updated links to point to the official documentation of v3.4.1 instead of v3.4.0.
  • I made the invariant masses of the particles positive by increasing their energies. Still, we might want to put something more realistic there in the future.
  • The role of registering the behavior using vector and using with_name="Momentum4D" is emphasized (and hopefully clearer).

@chrispap95 chrispap95 changed the title Improve documents docs: Improve documents Jun 27, 2023
@chrispap95 chrispap95 marked this pull request as ready for review June 27, 2023 13:57
@chrispap95 chrispap95 requested a review from lgray June 27, 2023 13:57
@chrispap95 chrispap95 changed the title docs: Improve documents docs: Improve documentation Jun 27, 2023
@lgray lgray merged commit f69650a into main Jul 2, 2023
@lgray lgray deleted the update-docs branch July 2, 2023 21:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

fastjet documentation examples have negative masses Add example with pt, eta, phi, M four-vector
2 participants