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

Documentation bugs and missing docstrings #14

Open
5 tasks done
g-bauer opened this issue May 11, 2022 · 0 comments
Open
5 tasks done

Documentation bugs and missing docstrings #14

g-bauer opened this issue May 11, 2022 · 0 comments
Labels
bug Something isn't working

Comments

@g-bauer
Copy link
Contributor

g-bauer commented May 11, 2022 •
edited

API

  • Add short example for each model in the api/model.md

UV Theory

  • EquationOfState.UVTheory:
    • wrong data type for parameters and wrong docstring
    • missing docstring for Perturbation
    • feos.uvtheory.Perturbation: missing docstring
    • feos.uvtheory.UVParameters: "binary saft parameter records"
    • feos.uvtheory.UVRecord: describe attributes and/or default constructor.
@g-bauer g-bauer added the bug Something isn't working label May 11, 2022
@prehner prehner added this to the feos v0.2.0 milestone Jul 11, 2022
@prehner prehner removed this from the feos v0.3.0 milestone Sep 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@g-bauer @prehner