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.

Sign up for GitHub

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

Jump to bottom

Add pre-commit hook for rstcheck #378

Merged
merged 1 commit into from
Apr 27, 2023
Merged

Add pre-commit hook for rstcheck #378

merged 1 commit into from
Apr 27, 2023

Conversation

BradonZhang
Copy link
Contributor

@BradonZhang BradonZhang commented Apr 25, 2023 •
edited

Issue number of the reported bug or feature request: #349

Describe your changes

  • Added rstcheck pre-commit hook to validate reStructuredText for news fragments.

Testing performed

  1. Created rST files in the news directory, both valid and invalid. Some good examples for invalid rST are found in the rstcheck README.
  2. Staged the files and ran pre-commit. Errors should pop up for the invalid files. Unstaging the invalid files should allow everything to pass.

Additional context
Closes #349

@BradonZhang
Add pre-commit hook for rstcheck
795343b 
Signed-off-by: Bradon Zhang <bradonzhang@gmail.com>
godlygeek
godlygeek approved these changes Apr 27, 2023
View reviewed changes
Copy link
Contributor

@godlygeek godlygeek left a comment

Choose a reason for hiding this comment

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

LGTM!

@godlygeek godlygeek merged commit 6e4837c into bloomberg:main Apr 27, 2023
26 checks passed
@godlygeek
Copy link
Contributor

Thanks for the contribution, @BradonZhang!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@godlygeek godlygeek godlygeek approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Ensure news fragments are valid reStructuredText
2 participants
@BradonZhang @godlygeek