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
Add vars eqs #22
Add vars eqs #22
Conversation
essm/equations/_core.py
Outdated
"""Equation interface.""" | ||
"""Equation interface. | ||
|
||
:raises ValueError: if the message_body exceeds 160 characters |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@schymans can you please update the docstring?
@@ -85,3 +85,7 @@ Physics | |||
|
|||
.. automodule:: essm.equations.physics.thermodynamics | |||
:members: | |||
|
|||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should add new section here ...
@schymans I have changed the base branch from |
essm/equations/_core.py
Outdated
@@ -31,7 +31,55 @@ | |||
|
|||
|
|||
class EquationMeta(type): | |||
"""Equation interface.""" | |||
"""Equation interface. Defines an equation with a docstring |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
$ pydocstyle essm
essm/equations/_core.py:33 in public class `EquationMeta`:
D301: Use r""" if any backslashes in a docstring
essm/equations/_core.py:33 in public class `EquationMeta`:
D400: First line should end with a period (not 'g')
essm/equations/_core.py:33 in public class `EquationMeta`:
D205: 1 blank line required between summary line and description (found 0)
essm/equations/_core.py:33 in public class `EquationMeta`:
D300: Use """triple double quotes""" (found """-quotes)
Fixes to EquationWriter and added test to make sure that the file generated is importable.