From 3d2396eef05e287d01161ec05c57890fea79b293 Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Thu, 8 Mar 2018 14:20:07 +0100 Subject: [PATCH 1/5] Temporary github PR template for sprint --- .github/PULL_REQUEST_TEMPLATE.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4e1e9ce017408..05da8eecd2c28 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,17 @@ +Checklist for the pandas documentation sprint (ignore this if you are doing +an unrelated PR): + +- [ ] PR title is "DOC: update the docstring" +- [ ] The validation script passes: `scripts/validate_docstrings.py ` +- [ ] The PEP8 style check passes: `git diff upstream/master -u -- "*.py" | flake8 --diff` +- [ ] The html version looks good: `python doc/make.py --single ` +- [ ] It has been proofread on language by another sprint participant + +If the validation script still gives errors, but you think there is a good reason +to deviate in this case, please state this explicitly. + +Checklist for other PRs: + - [ ] closes #xxxx - [ ] tests added / passed - [ ] passes `git diff upstream/master -u -- "*.py" | flake8 --diff` From b72808e3f1fbca57a1313342d89ed007e3965367 Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Thu, 8 Mar 2018 19:11:08 +0100 Subject: [PATCH 2/5] ask to paste output of validation script --- .github/PULL_REQUEST_TEMPLATE.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 05da8eecd2c28..557ae85bf6532 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,8 +7,21 @@ an unrelated PR): - [ ] The html version looks good: `python doc/make.py --single ` - [ ] It has been proofread on language by another sprint participant +Please include below the output of the validation script in the details tag: + +
+ +``` +# paste output of "scripts/validate_docstrings.py " here + +``` + +
+ If the validation script still gives errors, but you think there is a good reason -to deviate in this case, please state this explicitly. +to deviate in this case (and there are certainly such cases), please state this +explicitly. + Checklist for other PRs: From becf03c251598eec8396c5da73ad27ba72004d83 Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Thu, 8 Mar 2018 20:28:38 +0100 Subject: [PATCH 3/5] edit --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 557ae85bf6532..998a4ff37828d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,7 +7,7 @@ an unrelated PR): - [ ] The html version looks good: `python doc/make.py --single ` - [ ] It has been proofread on language by another sprint participant -Please include below the output of the validation script in the details tag: +Please include the output of the validation script under the details tag below:
From 0f6ee2944c17eb305500491abffd07cb8a9bae42 Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Fri, 9 Mar 2018 09:53:00 +0100 Subject: [PATCH 4/5] Update PULL_REQUEST_TEMPLATE.md --- .github/PULL_REQUEST_TEMPLATE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 998a4ff37828d..141b865d7ce76 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -13,6 +13,7 @@ Please include the output of the validation script under the details tag below: ``` # paste output of "scripts/validate_docstrings.py " here +# between the "```" (remove this comment, but keep the "```") ``` @@ -23,7 +24,7 @@ to deviate in this case (and there are certainly such cases), please state this explicitly. -Checklist for other PRs: +Checklist for other PRs (remove this part if you are doing a PR for the pandas documentation sprint): - [ ] closes #xxxx - [ ] tests added / passed From b7f98e6e79a21e3895c679c3a9af7251fccea466 Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Fri, 9 Mar 2018 10:02:54 +0100 Subject: [PATCH 5/5] remove details tag --- .github/PULL_REQUEST_TEMPLATE.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 141b865d7ce76..c1e02bd8eafc4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -7,9 +7,7 @@ an unrelated PR): - [ ] The html version looks good: `python doc/make.py --single ` - [ ] It has been proofread on language by another sprint participant -Please include the output of the validation script under the details tag below: - -
+Please include the output of the validation script below between the "```" ticks: ``` # paste output of "scripts/validate_docstrings.py " here @@ -17,8 +15,6 @@ Please include the output of the validation script under the details tag below: ``` -
- If the validation script still gives errors, but you think there is a good reason to deviate in this case (and there are certainly such cases), please state this explicitly.