Skip to content

DOCS: Formatting Errors pandas.TimedeltaIndex #29236

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.

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

Closed
HughKelley opened this issue Oct 26, 2019 · 0 comments · Fixed by #29257
Closed

DOCS: Formatting Errors pandas.TimedeltaIndex #29236

HughKelley opened this issue Oct 26, 2019 · 0 comments · Fixed by #29257
Labels

Comments

@HughKelley
Copy link
Contributor

HughKelley commented Oct 26, 2019

pandas/core/Indexes/timedeltas.py

#28602
#27977

pandas/core/indexes/base.py

python ./scripts/validate_docstrings.py pandas.TimedeltaIndex.to_series
7 Errors found:
	Summary should fit in a single line
	Parameter "index" description should start with a capital letter
	Parameter "index" description should finish with "."
	Parameter "name" description should start with a capital letter
	Parameter "name" description should finish with "."
	The first line of the Returns section should contain only the type, unless multiple values are being returned
	Return value has no description

pandas/core/arrays/datetime.py

./scripts/validate_docstrings.py pandas.TimedeltaIndex.mean
5 Errors found:
	Parameters {**kwargs, *args} not documented
	Unknown parameters {skipna}
	Parameter "skipna" description should finish with "."
	Return value has no description
	Missing description for See Also "numpy.ndarray.mean" reference
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants