DOC: Validate parameter types in docstrings (e.g. str instead of string)

[Moisan]

• tests added / passed
• passes git diff upstream/master -u -- "*.py" | flake8 --diff

Related to #20298. Fixes the bullet "Using string, boolean, integer in the param descriptions (should be str, bool, int)".

[pep8speaks]

Hello @Moisan! Thanks for updating the PR.

• There are no PEP8 issues in the file scripts/tests/test_validate_docstrings.py !

• There are no PEP8 issues in the file scripts/validate_docstrings.py !

Comment last updated on October 15, 2018 at 14:38 Hours UTC

[codecov]

Codecov Report

Merging #23165 into master will increase coverage by 0.04%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #23165      +/-   ##
==========================================
+ Coverage   92.14%   92.19%   +0.04%     
==========================================
  Files         170      169       -1     
  Lines       51017    50959      -58     
==========================================
- Hits        47011    46980      -31     
+ Misses       4006     3979      -27

Flag	Coverage Δ
#multiple	90.61% <ø> (+0.04%)	⬆️
#single	42.29% <ø> (-0.02%)	⬇️

Impacted Files	Coverage Δ
pandas/plotting/_compat.py	87.5% <0%> (-3.81%)	⬇️
pandas/compat/numpy/__init__.py	92.85% <0%> (-1.09%)	⬇️
pandas/plotting/_converter.py	63.82% <0%> (-0.07%)	⬇️
pandas/core/util/hashing.py	98.4% <0%> (ø)	⬆️
pandas/core/frame.py	97.11% <0%> (ø)	⬆️
pandas/compat/pickle_compat.py	75.6% <0%> (ø)	⬆️
pandas/core/dtypes/common.py	95.11% <0%> (ø)	⬆️
pandas/core/arrays/__init__.py	100% <0%> (ø)	⬆️
pandas/core/sparse/api.py	100% <0%> (ø)	⬆️
pandas/core/sparse/array.py
... and 8 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cf11f71...26bf7be. Read the comment docs.

[datapythonista]

Thanks for this, it's very useful. I'd just add the mentioned test, as it's more common having multiple types than just one.

[datapythonista]

Can you add one test or two for something like list of boolean, integer, float or string... I think it makes sense to make sure that we capture them, and that the error in this case makes sense.

[datapythonista]

lgtm, thanks @Moisan

@WillAyd can you take a look?

[WillAyd]

Thanks @Moisan !