fix: improve signatures in helicity module #242
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
redeboer
added a commit
that referenced
this pull request
Feb 25, 2022
* chore: rename __mapping to __parameters * chore: simplify get/setitem implementation of ParameterValues * ci: ignore _all_ .tmp files with sphinx-autobuild * docs: abbreviate ParameterValue type alias where possible * docs: improve get/setitem argument signatures in API * docs: show ParameterValues.__setitem__() in API * fix: improve signature HelicityModel components and kinematic_variables arguments
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.
Note: it's not yet possible to abbreviate type aliases in nested type hints. Sphinx will fix this (sphinx-doc/sphinx#10183) in v4.5.0. This will also make it possible to improve the order of definitions in the
helicitymodule (makes more sense to defineHelicityModelfirst). See also ComPWA/.github#5.