Skip to content

Commit b85f6c1

Browse files
datapythonistajorisvandenbossche
authored andcommitted
DOC: update docstring validation script + replace api coverage script (pandas-dev#20025)
* Improvments to validate_docstrings script: adding sections to summary, validating type and description of parameters * DOC: Improvements to validate docstring script (added api_coverage functionality, sections in csv and extra validations)
1 parent 9273bf5 commit b85f6c1

File tree

3 files changed

+198
-174
lines changed

3 files changed

+198
-174
lines changed

doc/source/contributing.rst

+4-2
Original file line numberDiff line numberDiff line change
@@ -351,8 +351,10 @@ Some other important things to know about the docs:
351351

352352
pandoc doc/source/contributing.rst -t markdown_github > CONTRIBUTING.md
353353

354-
The utility script ``scripts/api_rst_coverage.py`` can be used to compare
355-
the list of methods documented in ``doc/source/api.rst`` (which is used to generate
354+
The utility script ``scripts/validate_docstrings.py`` can be used to get a csv
355+
summary of the API documentation. And also validate common errors in the docstring
356+
of a specific class, function or method. The summary also compares the list of
357+
methods documented in ``doc/source/api.rst`` (which is used to generate
356358
the `API Reference <http://pandas.pydata.org/pandas-docs/stable/api.html>`_ page)
357359
and the actual public methods.
358360
This will identify methods documented in ``doc/source/api.rst`` that are not actually

scripts/api_rst_coverage.py

-98
This file was deleted.

0 commit comments

Comments
 (0)