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: abbreviate type aliases in API #207

Merged
merged 11 commits into from
Jan 18, 2022

Conversation

redeboer
Copy link
Member

@redeboer redeboer commented Jan 18, 2022

See ComPWA/policy#59

Old New
image image

Also addresses ComPWA/policy#58. Note, though, that abbreviate_signature.py (now _relink_references.py) is rather complex. This is in order to maintain compatibility with Sphinx <4.4, which is installed in Python <3.8.

@redeboer redeboer added the 📝 Docs Improvements or additions to documentation label Jan 18, 2022
@redeboer redeboer self-assigned this Jan 18, 2022
@redeboer redeboer added this to the 0.12.2 milestone Jan 18, 2022
@redeboer redeboer merged commit 964f255 into ComPWA:main Jan 18, 2022
@redeboer redeboer deleted the autodoc_type_aliases branch January 18, 2022 14:44
redeboer added a commit to redeboer/ComPWA-qrules that referenced this pull request Jan 20, 2022
redeboer added a commit to redeboer/ComPWA-qrules that referenced this pull request Jan 21, 2022
redeboer added a commit to ComPWA/tensorwaves that referenced this pull request Jan 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📝 Docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant