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

Format doc strings #3790

Merged
merged 11 commits into from
Apr 28, 2024
Merged

Format doc strings #3790

merged 11 commits into from
Apr 28, 2024

Conversation

janosh
Copy link
Member

@janosh janosh commented Apr 28, 2024

plus minor formatting and 1 deprecation of NRANDOM -> n_random in coordination_geometry_symmetry_measures_fallback_random

@janosh janosh added linting Linting and quality assurance docs Documentation, examples, user guides ux User experience labels Apr 28, 2024
@janosh janosh enabled auto-merge (squash) April 28, 2024 22:20
@janosh janosh disabled auto-merge April 28, 2024 22:41
@janosh janosh merged commit 9964c4a into master Apr 28, 2024
7 of 8 checks passed
@janosh janosh deleted the doc-strings branch April 28, 2024 22:41
@esoteric-ephemera
Copy link
Contributor

@janosh : this broke some code in pymatgen-analysis-diffusion and thus also in emmet, particularly the change from symmop to symm_op in Structure.apply_operation. Can we announce breaking changes or avoid them if they're made for code style?

@shyuep
Copy link
Member

shyuep commented May 7, 2024

@janosh Seriously, stop breaking stuff with this kind of cosmetic stuff. I am going to insist that you maintain backwards compatibility. Otherwise, I am revoking your write privileges and you will submit PRs like everyone else.

@janosh
Copy link
Member Author

janosh commented May 10, 2024

@esoteric-ephemera sorry about the hassle and thanks for taking the time to fix!

@shyuep i'll be more careful. i realized that this change could be breaking and did a search for symmop being passed as keyword in pymatgen and atomate2 but ofc that leaves a lot of places where it could matter. just to clarify though, i did submit a PR for this like everyone else and CI passed so I doubt a reviewer would have noticed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation, examples, user guides linting Linting and quality assurance ux User experience
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants