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

Fix docs #19

Merged
merged 3 commits into from
Oct 8, 2024
Merged

Fix docs #19

merged 3 commits into from
Oct 8, 2024

Conversation

szabo137
Copy link
Member

@szabo137 szabo137 commented Oct 4, 2024

Closes #14

Checklist

  • Tests are passing
  • Docs were updated and workflow is passing

@szabo137 szabo137 requested a review from grasph October 4, 2024 20:52
@szabo137 szabo137 changed the title Fix docs [WIP] Fix docs Oct 4, 2024
@grasph
Copy link
Member

grasph commented Oct 5, 2024

I'm not convinced by the new interface name (neither by the package name btw).

However, I prefer to postpone discussions on naming, once we have agreed on the interface definition and on the scope of this package. It's easier to name something, once we know what the thing is. So it's fine for me to keep the new wording for time being.

+1

@Moelf
Copy link
Member

Moelf commented Oct 5, 2024

I suggest we don't say anything about "object with LV inside" other than pointing out this package just focus on LV and "particle" or whatever shouldn't be <:AbstractLorentzVector. Because they won't (generally) be compatible with LV interface.

@mmikhasenko
Copy link
Member

minor comments, can be merged once resolved.
Thanks

@szabo137 szabo137 changed the title [WIP] Fix docs Fix docs Oct 8, 2024
@szabo137
Copy link
Member Author

szabo137 commented Oct 8, 2024

I removed the docs preview todo for now but opened #23

@mmikhasenko if you are happy with my comments, than I would like to merge ;-)

@szabo137 szabo137 merged commit ba9d0eb into main Oct 8, 2024
4 checks passed
@Moelf Moelf deleted the fix-docs branch October 8, 2024 11:47
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.

Fix interface doc markdown
4 participants