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

DOC: hide sympified attributes from expression classes #424

Merged
merged 5 commits into from
May 20, 2024

Conversation

redeboer
Copy link
Member

Arguments that are sympified were previously rendered as class attributes. This PR hides them from API of the expression classes (if they do not have a __doc__ docstring), because they are already visible in the signature of the class.

image

@redeboer redeboer added the 📝 Docs Improvements or additions to documentation label May 20, 2024
@redeboer redeboer added this to the 0.15.3 milestone May 20, 2024
@redeboer redeboer self-assigned this May 20, 2024
@redeboer redeboer changed the title Clean up api DOC: hide sympified attributes from expression classes May 20, 2024
@redeboer redeboer enabled auto-merge (squash) May 20, 2024 21:26
@redeboer redeboer merged commit 752860e into ComPWA:main May 20, 2024
20 checks passed
@redeboer redeboer deleted the clean-up-api branch May 20, 2024 21:30
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