Skip to content

STYLE, CI move validate_rst_title_capitalization check to pre-commit #39779

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

Conversation

MarcoGorelli
Copy link
Member

@MarcoGorelli MarcoGorelli commented Feb 12, 2021

  • Ensure all linting tests pass, see here for how to run them

xref #39624 in which it took ~15 minutes for @rhshadrach to be told

Heading capitalization formatted incorrectly. Please correctly capitalize "pytest.xfail" to "Pytest.xfail" 

, like this such feedback will be provided much faster

"""
The main method to print all headings with incorrect capitalization.

Parameters
----------
source_paths : str
List of directories to validate, provided through command line arguments.
output_format : str
Copy link
Member Author

Choose a reason for hiding this comment

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

looks like this was unused anyway

@MarcoGorelli MarcoGorelli force-pushed the validate-title-capitalization-pre-commit branch from 26e4ba6 to 0899cdf Compare February 12, 2021 18:01
@@ -233,10 +233,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
$BASE_DIR/scripts/validate_docstrings.py --format=actions --errors=GL03,GL04,GL05,GL06,GL07,GL09,GL10,SS02,SS04,SS05,PR03,PR04,PR05,PR10,EX04,RT01,RT04,RT05,SA02,SA03
RET=$(($RET + $?)) ; echo $MSG "DONE"

MSG='Validate correct capitalization among titles in documentation' ; echo $MSG
$BASE_DIR/scripts/validate_rst_title_capitalization.py $BASE_DIR/doc/source/development $BASE_DIR/doc/source/reference
Copy link
Member Author

Choose a reason for hiding this comment

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

any reason why this was only run in two directories? I guess it could be expanded now

@lithomas1 lithomas1 added CI Continuous Integration Code Style Code style, linting, code_checks labels Feb 13, 2021
@jreback jreback added this to the 1.3 milestone Feb 15, 2021
@jreback jreback merged commit 00ddacf into pandas-dev:master Feb 15, 2021
@jreback
Copy link
Contributor

jreback commented Feb 15, 2021

thanks @MarcoGorelli

@MarcoGorelli MarcoGorelli deleted the validate-title-capitalization-pre-commit branch February 16, 2021 09:55
znicholls pushed a commit to znicholls/pandas that referenced this pull request Feb 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration Code Style Code style, linting, code_checks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants