Skip to content

Refs #34140 -- Added a blacken-docs section to writing-documentation … #19605

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

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

smithdc1
Copy link
Member

@smithdc1 smithdc1 commented Jun 29, 2025

ticket-36485

Branch description

Doc'd the blacken-docs rule in the doc's makefile and added a new rule called 'check'. This new rule runs both the 'black' and 'spelling' rules in a single step. Both of these rules are enforced in CI.

Checklist

  • This PR targets the main branch.
  • The commit message is written in past tense, mentions the ticket number, and ends with a period.
  • I have checked the "Has patch" ticket flag in the Trac system.
  • I have added or updated relevant tests.
  • I have added or updated relevant docs, including release notes if applicable.
  • I have attached screenshots in both light and dark modes for any UI changes.

smithdc1 added 2 commits June 29, 2025 13:13
Added a 'check' rule to the docs makefile which runs both the
black and spelling rules. These two rules are required to pass CI before
merging.
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.

1 participant