Skip to content

DOC: Validate reST directives in docstrings #27629

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

Jump to bottom
Closed
albertvillanova opened this issue Jul 28, 2019 · 0 comments · Fixed by #27630
Closed

DOC: Validate reST directives in docstrings #27629

albertvillanova opened this issue Jul 28, 2019 · 0 comments · Fixed by #27630
Labels
Docs

Comments

@albertvillanova
Copy link
Contributor

Code Sample, a copy-pastable example if possible

python scripts/validate_docstrings.py pandas.Series.item

Problem description

As pointed out by PR #27621, scripts/validate_docstrings.py does not detect dosctrings containing a reST directive without two colons.

Expected Output

The script should report an error in this case.
albertvillanova added a commit to albertvillanova/pandas that referenced this issue Jul 28, 2019
@albertvillanova
Validate docstring directives
e1f3606 
Fix pandas-dev#27629
@albertvillanova albertvillanova mentioned this issue Jul 28, 2019
Merged
5 tasks
gfyoung pushed a commit that referenced this issue Aug 6, 2019
@albertvillanova @gfyoung
DOC: Validate docstring directives (#27630)
54e5803 
Closes gh-27629
quintusdias pushed a commit to quintusdias/pandas_dev that referenced this issue Aug 16, 2019
@albertvillanova @quintusdias
DOC: Validate docstring directives (pandas-dev#27630)
575ac7a 
Closes pandas-devgh-27629
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC: Validate docstring directives albertvillanova/pandas
2 participants
@jbrockmendel @albertvillanova