fixes docs 10- issue #72
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Remove physical constraint validation in Invariants function - Use a default constant for border point generation in Dalitz plot - Standardize type parameter formatting in type definitions
…tam.jl - Add proper docstring formatting for `σjofk` and `σiofk` functions - Standardize type parameter spacing in `MandelstamTuple` - Add cross-reference to related function using `[@ref]`
- Add return type annotations to function signatures - Reposition helper functions for better readability - Update docstring formatting and cross-references
- Add multiple examples to `Kallen`, `sqrtKallenFact`, `Kibble`, `breakup`, `aligned_four_vectors`, and `isphysical` functions - Improve docstring readability with `jldoctest` blocks - Include practical usage scenarios and edge case demonstrations - Update cross-references and formatting for consistency
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related issues
Closes #
Checklist
I am following the contributing guidelines
Tests are passing
Lint workflow is passing
Docs were updated and workflow is passing