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

Documentation for base_state and propagator #102

Open
AntonReinhard opened this issue Jul 15, 2024 · 0 comments
Open

Documentation for base_state and propagator #102

AntonReinhard opened this issue Jul 15, 2024 · 0 comments
Labels
07 - Documentation Improvements or additions to documentation

Comments

@AntonReinhard
Copy link
Member

The doc strings for base_state and propagator should be updated to reflect that they're interface functions supposed to be implemented by QEDcore (or another implementing package)

Also, the signature of propagator allows an optional mass value to be passed, which is not actually implemented in QEDcore, probably because the mass is known from the AbstractParticleType's mass function anyways, so the parameter is unnecessary.

@AntonReinhard AntonReinhard added the 07 - Documentation Improvements or additions to documentation label Aug 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
07 - Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant