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

Fix docs in staticKS.py #16

Merged
merged 9 commits into from
Jun 27, 2021
Merged

Fix docs in staticKS.py #16

merged 9 commits into from
Jun 27, 2021

Conversation

DanielKotik
Copy link
Contributor

@DanielKotik DanielKotik commented Jun 26, 2021

@timcallow : Please fix the following issues:

  • add a description for parameter orbs in class Density and change type to the correct one
  • fix the documentation of properties for classes Orbitals, Potential and Energy in a similar way as I have done it for Density

Please refer to the following documents:

The provided commits fix warnings a la:

.../atoMEC_import/atoMEC/staticKS.py:docstring of atoMEC.staticKS.Density.bound:1:duplicate
object description of atoMEC.staticKS.Density.bound, other instance in api/atoMEC, use :noindex: for one of them

Always check locally with make clean and make html (or make SPHINXOPTS="-W" html).

Once this PR is ready for review, let me know;)

@timcallow timcallow marked this pull request as ready for review June 27, 2021 10:40
@timcallow
Copy link
Contributor

timcallow commented Jun 27, 2021

@DanielKotik Seems the fixes above remove the errors for me, so I believe this is ready for review

@timcallow timcallow marked this pull request as draft June 27, 2021 11:44
@timcallow timcallow marked this pull request as ready for review June 27, 2021 11:45
@timcallow timcallow marked this pull request as draft June 27, 2021 11:48
Copy link
Contributor Author

@DanielKotik DanielKotik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@DanielKotik DanielKotik marked this pull request as ready for review June 27, 2021 19:20
@DanielKotik DanielKotik merged commit ffabc8e into documentation Jun 27, 2021
@DanielKotik DanielKotik deleted the fix-docs-in-staticKS branch June 27, 2021 19:26
@timcallow timcallow mentioned this pull request Jun 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants