Skip to content

WEB: Remove from roadmap moving the docstring script #30893

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
merged 1 commit into from
Jan 10, 2020
Merged

WEB: Remove from roadmap moving the docstring script #30893

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 0 additions & 14 deletions doc/source/development/roadmap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,20 +129,6 @@ Some specific goals include
* Improve the overall organization of the documentation and specific subsections
of the documentation to make navigation and finding content easier.

Package docstring validation
----------------------------

To improve the quality and consistency of pandas docstrings, we've developed
tooling to check docstrings in a variety of ways.
https://github.com/pandas-dev/pandas/blob/master/scripts/validate_docstrings.py
contains the checks.

Like many other projects, pandas uses the
`numpydoc <https://numpydoc.readthedocs.io/en/latest/>`__ style for writing
docstrings. With the collaboration of the numpydoc maintainers, we'd like to
move the checks to a package other than pandas so that other projects can easily
use them as well.

Performance monitoring
----------------------

Expand Down
13 changes: 0 additions & 13 deletions web/pandas/about/roadmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,19 +134,6 @@ pandas documentation. Some specific goals include
subsections of the documentation to make navigation and finding
content easier.

## Package docstring validation

To improve the quality and consistency of pandas docstrings, we've
developed tooling to check docstrings in a variety of ways.
<https://github.com/pandas-dev/pandas/blob/master/scripts/validate_docstrings.py>
contains the checks.

Like many other projects, pandas uses the
[numpydoc](https://numpydoc.readthedocs.io/en/latest/) style for writing
docstrings. With the collaboration of the numpydoc maintainers, we'd
like to move the checks to a package other than pandas so that other
projects can easily use them as well.

## Performance monitoring

Pandas uses [airspeed velocity](https://asv.readthedocs.io/en/stable/)
Expand Down