Skip to content

Conversation

@kwagoner94
Copy link
Contributor

Fixed codespell erros and suppressed known terms (e.g., DISCUS, CONECT, Nd, Te, BU, discus, etc.) using --ignore-regex in .pre-commit-config.yaml.

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

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

This seems to be a mix of black and codespell changes. I wonder if something went wrong with the workflow. I don't want to create extra work, but it would sure be easier to review if they were on separate PRs. Is it possible that you ran black but not on all files and directories? SOmething like htat.

Maybe create a new branch off a synced main and try and run black on everything and see what happens. If we can regenerate the white-space and single-double quote fixes, I can merge them, then we can merge that into this branch.

It may be better if you could pick a tier-2 project as a first one where any mistakes we make are less consequential?

@kwagoner94
Copy link
Contributor Author

I created a new branch off a synced main and ran black on everything. All files were left unchanged. Should I just re do the package create public from here and re-edit the codespell changes?

@sbillinge
Copy link
Contributor

Can we switch to another project and then come back to this one?

The only files that should be modified on this one should be the handful that had typo's caught by codespell, not 102 files. Were you very selective about the files that you added to the commit? Kind of one at a time as you worked on them?

@kwagoner94
Copy link
Contributor Author

I'm not sure what I did wrong in my workflow. I can go back and start over tomorow by editing the files with the codespell errors.

@kwagoner94 kwagoner94 closed this Jun 9, 2025
@kwagoner94 kwagoner94 deleted the pre-commit-spelling branch June 9, 2025 03:07
@kwagoner94 kwagoner94 restored the pre-commit-spelling branch June 9, 2025 03:08
@kwagoner94 kwagoner94 deleted the pre-commit-spelling branch June 9, 2025 03:09
@sbillinge
Copy link
Contributor

there's probably a way of reocoving the work you did so it is not lost (it will be on a different clean branch) but as a first cut starting over but working on a tier-2 project as a first one would be my preference. There is a learning curve, but this goes very quickly once over the hump.

@kwagoner94
Copy link
Contributor Author

Do you have a tier 2 project in mind that I could work on?

@sbillinge
Copy link
Contributor

@kwagoner94 how about trying diffpy.srmise?

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.

2 participants