Closed jAniceto closed 3 years ago
Thanks. I'll pull down the changes and let you know if I have any questions.
I ran your code and encountered several issues:
[1]_
instead of [1]
.toctree
in the index.rst
file.Hi. Thanks for the feedback. Regarding your points:
.. math::
line in the function docstring. I saw several other function where the equations did not wrap so I though I was supposed to follow that style.Yes, you can remove the numbering. But if you want to use a footnote for a reference it needs to have an underscore such as [1]_
otherwise Sphinx will complain and not properly build the documentation.
For the Flake8 style, this
pressure_drop = 150*mu*(1-epsilon)**2*u0/(dp**2*epsilon**3) + \
1.75*rhof*(1-epsilon)*u0**2/(dp*epsilon**3)
should be
pressure_drop = 150 * mu * (1 - epsilon)**2 * u0 / (dp**2 * epsilon**3) + \
1.75 * rhof * (1 - epsilon) * u0**2 / (dp * epsilon**3)
I am ignoring the E501,W503,W605
errors which I should mention in the contribution document.
I'll have to check why my linter isn't signaling that then.
I've added commits to fix the reference, toctree, and flake8 issues. Think that covers the problems.
Thanks, everything looks good. I changed the base branch to develop
instead of merging directly into the main
branch. Your contributions will be part of version 21.5 which will be released in May. If you decide to submit more pull requests, please make them to the develop
branch and not to the main
branch.
This is a small pull request to test the git workflow.