File tree 1 file changed +24
-0
lines changed
1 file changed +24
-0
lines changed Original file line number Diff line number Diff line change
1
+ Checklist for the pandas documentation sprint (ignore this if you are doing
2
+ an unrelated PR):
3
+
4
+ - [ ] PR title is "DOC: update the <your-function-or-method > docstring"
5
+ - [ ] The validation script passes: ` scripts/validate_docstrings.py <your-function-or-method> `
6
+ - [ ] The PEP8 style check passes: ` git diff upstream/master -u -- "*.py" | flake8 --diff `
7
+ - [ ] The html version looks good: ` python doc/make.py --single <your-function-or-method> `
8
+ - [ ] It has been proofread on language by another sprint participant
9
+
10
+ Please include the output of the validation script below between the "```" ticks:
11
+
12
+ ```
13
+ # paste output of "scripts/validate_docstrings.py <your-function-or-method>" here
14
+ # between the "```" (remove this comment, but keep the "```")
15
+
16
+ ```
17
+
18
+ If the validation script still gives errors, but you think there is a good reason
19
+ to deviate in this case (and there are certainly such cases), please state this
20
+ explicitly.
21
+
22
+
23
+ Checklist for other PRs (remove this part if you are doing a PR for the pandas documentation sprint):
24
+
1
25
- [ ] closes #xxxx
2
26
- [ ] tests added / passed
3
27
- [ ] passes ` git diff upstream/master -u -- "*.py" | flake8 --diff `
You can’t perform that action at this time.
0 commit comments