Skip to content

Replace api coverage script #20025

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.

Sign up for GitHub

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

Merged
jorisvandenbossche merged 5 commits into from
Mar 8, 2018
Merged

Replace api coverage script #20025

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4ee2772
Improvments to validate_docstrings script: adding sections to summary…
datapythonista Mar 6, 2018
a365b9c
Merge remote-tracking branch 'upstream/master' into replace_api_cover…
datapythonista Mar 6, 2018
2c83797
DOC: Improvements to validate docstring script (added api_coverage fu…
datapythonista Mar 7, 2018
7305b7d
Using doc from pydoc, sorting params and see also, and fixing bug mak…
datapythonista Mar 7, 2018
2c5b338
Fixing bug where parameters reported wrong order incorrectly due to c…
datapythonista Mar 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions doc/source/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,8 +351,10 @@ Some other important things to know about the docs:

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

The utility script ``scripts/api_rst_coverage.py`` can be used to compare
the list of methods documented in ``doc/source/api.rst`` (which is used to generate
The utility script ``scripts/validate_docstrings.py`` can be used to get a csv
summary of the API documentation. And also validate common errors in the docstring
of a specific class, function or method. The summary also compares the list of
methods documented in ``doc/source/api.rst`` (which is used to generate
the `API Reference <http://pandas.pydata.org/pandas-docs/stable/api.html>`_ page)
and the actual public methods.
This will identify methods documented in ``doc/source/api.rst`` that are not actually
Expand Down
98 changes: 0 additions & 98 deletions scripts/api_rst_coverage.py
View file
Open in desktop

This file was deleted.

Loading