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

Small clarification to get_conventional_standard_structure docstring in symmetry/analyzer.py #2100

Merged
merged 2 commits into from
Mar 22, 2021

Conversation

tom-wood
Copy link
Contributor

Summary

Include a summary of major changes in bullet points:
*Small addition to docstring of get_conventional_standard_structure to clarify that it does not produce the standard ITC setting (this is done by get_refined_structure).

Closes #2097.

Additional dependencies introduced (if any)

  • None

TODO (if any)

None

Checklist

Work-in-progress pull requests are encouraged, but please put [WIP]
in the pull request title.

Before a pull request can be merged, the following items must be checked:

  • Code is in the standard Python style. The easiest way to handle this
    is to run the following in the correct sequence on your local machine. Start with running
    black on your new code. This will automatically reformat
    your code to PEP8 conventions and removes most issues. Then run
    pycodestyle, followed by
    flake8.
  • Docstrings have been added in the Google docstring format.
    Run pydocstyle on your code.
  • Type annotations are highly encouraged. Run mypy to type check your code.
  • Tests have been added for any new functionality or bug fixes.
  • All linting and tests pass.

Note that the CI system will run all the above checks. But it will be much more efficient if you already fix most
errors prior to submitting the PR. It is highly recommended that you use the pre-commit hook provided in the pymatgen
repository. Simply cp pre-commit .git/hooks and a check will be run prior to allowing commits.

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.6%) to 83.002% when pulling 8aae967 on tom-wood:master into 2e5a4bb on materialsproject:master.

@mkhorton mkhorton merged commit eb4d034 into materialsproject:master Mar 22, 2021
@mkhorton
Copy link
Member

Thanks for adding this @tom-wood. I agree this is confusing, at minimum being more explicit in the documentation definitely helps.

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.

SpacegroupAnalyzer.get_conventional_standard_structure additional documentation
3 participants