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.

Sign up for GitHub

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

Jump to bottom

docs: clean up API of kinematics module #211

Merged
merged 44 commits into from
Jan 24, 2022
Merged

docs: clean up API of kinematics module #211

merged 44 commits into from
Jan 24, 2022

Conversation

redeboer
Copy link
Member

@redeboer redeboer commented Jan 24, 2022 •
edited

Preview here. Compare to v0.12.2.

  • Definitions in the API are follow the sorting of the source code.
  • Hidden the classes for SymPy ArraySymbols by moving them to ampform.sympy._array_expresssions.
  • Added docstrings to all remaining classes, like BoostZ.
  • Improved the docs/_extend_docstrings.py script.
  • Hidden several methods and attributes that come from sympy.Basic.
  • See commit history for other changes.

@redeboer
fix: remove precedence attribute from API
5f1b228
@redeboer
fix: type hint partial decays
d3e6bf8
@redeboer
docs: ref formulate_wigner_d and formulate_clebsch_gordan_coefficients
2be7500
@redeboer
refactor: simplify make_commutative decorator
ebcaa9c
@redeboer
fix: use TypeVar for decorated class
707d40c
@redeboer
refactor: hide implement_latex_subscript decorator
c9ca616
@redeboer
fix: remove is_extended_real from API
607877c
@redeboer
docs: hide as_explicit() from API
331685c
@redeboer
docs: hide symbolic SymPy Array classes from API
8331280
@redeboer
docs: create type alias for FourMomentumSymbol
d248e2d
@redeboer
fix: change angle type hint to Expr
014ead0
@redeboer
docs: define properties as methods
2edd0f9 
If defined with a lambda, the type hints disappear in the API
@redeboer
docs: improve docstrings of four-momentum components
69cacec
@redeboer
docs: improve docstring BoostZ
3282ba7
@redeboer
chore: extract _create_latex_doit_definition()
67514b4
@redeboer
docs: improve docstring RotationY/Z
a094c3a
@redeboer
docs: improve docstrings of remaining kinematics classes
6ba7ff2
@redeboer
refactor: remove HasMomentum class
dfe6569
@redeboer
docs: generalize kinematics module description
5eb7e4d
@redeboer
chore: hide _update_docstring
e5caad2
@redeboer
chore: rename render to extend
596e7e8
@redeboer
chore: rename function to extend_docstrings()
717974d
@redeboer
chore: make script_name inline
b3f5905
@redeboer
chore: extract _append_latex_doit_definition()
b83106d
@redeboer
chore: import extended docstring classes inline
a483e36
@redeboer
chore: move extend_docstrings() to top
7189d11
@redeboer
chore: rename to _append_to_docstring()
91e822f
@redeboer
chore: match extend function names
de1cc20
@redeboer
chore: sort extend methods
0b21cd9
@redeboer
docs: sort API by source, not alphabetical
131cbb1
@redeboer redeboer added the 📝 Docs Improvements or additions to documentation label Jan 24, 2022
@redeboer redeboer added this to the 0.12.3 milestone Jan 24, 2022
@redeboer redeboer self-assigned this Jan 24, 2022
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

@redeboer redeboer merged commit 7352620 into ComPWA:main Jan 24, 2022
@redeboer redeboer deleted the improve-kinematics-API branch January 24, 2022 11:07
This was referenced Jan 28, 2022
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@redeboer redeboer

Labels
📝 Docs Improvements or additions to documentation
Projects
None yet
Milestone
0.12.3
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@redeboer