pandas: DOC fix EX02 errors in docstrings

pandas has a script for validating docstrings

https://github.com/pandas-dev/pandas/blob/ced983358b06576af1a73c3e936171cc6dc98a6d/ci/code_checks.sh#L560-L568

which can be run with

./ci/code_checks.sh docstrings

Currently, many functions fail the EX02 check, and so are excluded from the check.

The task here is:

pick 2-3 functions
run ./ci/code_checks.sh docstrings
fixup the docstrings according to whatever error is reported
stage, commit, push, open pull request 🚀

Please don’t comment take as multiple people can work on this simultaneously. You also don’t need to ask for permission to work on this, feel free to just start 😄 Though if you’re working on some set of functions you can comment that

If you’re new here, please check the contributing guide https://pandas.pydata.org/docs/dev/development/contributing.html

TIP: ./ci/code_checks.sh docstrings may take a while to run - you may want to comment-out the docstrings check which checks EX01 and the part which checks all the other codes (these are currently lines 86 - 577)

About this issue

Original URL
State: closed
Created a year ago
Comments: 34 (25 by maintainers)

Most upvoted comments

Great, I’m working on them now!

phershbe on Mar 1, 2023

I am working on: pandas.core.groupby.SeriesGroupBy.take pandas.merge_ordered pandas.option_context

natmokval on Feb 15, 2023

Hi, I am working on: pandas.api.types.is_datetime64_any_dtype pandas.api.types.is_datetime64_ns_dtype
pandas.api.types.is_datetime64tz_dtype This is going to be my first open source contribution and I might need some help 😃

kindai321 on Feb 14, 2023

Hi, I will work on: pandas.api.types.is_float_dtype pandas.api.types.is_int64_dtype

natmokval on Feb 10, 2023

Working on: pandas.api.types.is_bool_dtype pandas.api.types.is_categorical_dtype pandas.api.types.is_complex_dtype

DeaMariaLeon on Feb 9, 2023

Hi, currently working on :

pandas.factorize pandas.Index.factorize pandas.Series.factorize

albuzenet on Feb 8, 2023