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

Nick/link check #359

Merged
merged 5 commits into from
Jan 6, 2025
Merged

Nick/link check #359

merged 5 commits into from
Jan 6, 2025

Conversation

ntjohnson1
Copy link
Collaborator

@ntjohnson1 ntjohnson1 commented Dec 14, 2024

Resolves #358 (if successful)

Also adds codespell to our checks.
Its used in another repo I was contributing to, has 2k stars, runs fast, and is easy to configure. I didn't dig much deeper than that and it caught a bunch of our typos.
I updated the contributing doc, our pre-commit, package tests, and pyproject config to support it. I think that covers all the bases.


📚 Documentation preview 📚: https://pyttb--359.org.readthedocs.build/en/359/

@ntjohnson1
Copy link
Collaborator Author

The link checker didn't flake on multiple runs. Unfortunately, I wasn't able to figure out how to make the output more verbose, so it's possible I misconfigured it and we are no longer checking links (I don't think that's likely but I can't say 100%)

@ntjohnson1 ntjohnson1 marked this pull request as ready for review December 14, 2024 14:57
@ntjohnson1 ntjohnson1 mentioned this pull request Dec 15, 2024
@dmdunla dmdunla merged commit c3249ad into sandialabs:main Jan 6, 2025
9 checks passed
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.

Check Markdown links GitHub Action has frequent errors that are resolved after 1 or more re-runs
2 participants