-
-
Notifications
You must be signed in to change notification settings - Fork 18.7k
Closed
Labels
Description
follow up on issues #56804 and #58063
pandas has a script for validating docstrings:
Lines 206 to 244 in 0cdc6a4
-i "pandas.Timestamp.combine PR01,SA01" \ | |
-i "pandas.Timestamp.ctime SA01" \ | |
-i "pandas.Timestamp.date SA01" \ | |
-i "pandas.Timestamp.day GL08" \ | |
-i "pandas.Timestamp.fold GL08" \ | |
-i "pandas.Timestamp.fromordinal SA01" \ | |
-i "pandas.Timestamp.fromtimestamp PR01,SA01" \ | |
-i "pandas.Timestamp.hour GL08" \ | |
-i "pandas.Timestamp.max PR02" \ | |
-i "pandas.Timestamp.microsecond GL08" \ | |
-i "pandas.Timestamp.min PR02" \ | |
-i "pandas.Timestamp.minute GL08" \ | |
-i "pandas.Timestamp.month GL08" \ | |
-i "pandas.Timestamp.month_name SA01" \ | |
-i "pandas.Timestamp.nanosecond GL08" \ | |
-i "pandas.Timestamp.normalize SA01" \ | |
-i "pandas.Timestamp.quarter SA01" \ | |
-i "pandas.Timestamp.replace PR07,SA01" \ | |
-i "pandas.Timestamp.resolution PR02" \ | |
-i "pandas.Timestamp.second GL08" \ | |
-i "pandas.Timestamp.strptime PR01,SA01" \ | |
-i "pandas.Timestamp.timestamp SA01" \ | |
-i "pandas.Timestamp.timetuple SA01" \ | |
-i "pandas.Timestamp.timetz SA01" \ | |
-i "pandas.Timestamp.to_datetime64 SA01" \ | |
-i "pandas.Timestamp.to_julian_date SA01" \ | |
-i "pandas.Timestamp.to_numpy PR01" \ | |
-i "pandas.Timestamp.to_period PR01,SA01" \ | |
-i "pandas.Timestamp.today SA01" \ | |
-i "pandas.Timestamp.toordinal SA01" \ | |
-i "pandas.Timestamp.tz_localize SA01" \ | |
-i "pandas.Timestamp.tzinfo GL08" \ | |
-i "pandas.Timestamp.tzname SA01" \ | |
-i "pandas.Timestamp.unit SA01" \ | |
-i "pandas.Timestamp.utcfromtimestamp PR01,SA01" \ | |
-i "pandas.Timestamp.utcoffset SA01" \ | |
-i "pandas.Timestamp.utctimetuple SA01" \ | |
-i "pandas.Timestamp.value GL08" \ | |
-i "pandas.Timestamp.year GL08" \ |
Currently, some methods fail docstring validation check.
The task here is:
- take 2-4 methods
- run:
scripts/validate_docstrings.py <method-name>
- fix the docstrings according to whatever error is reported
- remove those methods from
code_checks.sh
script - commit, push, open pull request
Example:
scripts/validate_docstrings.py pandas.Timestamp.tz_localize
pandas.Timestamp.tz_localize fails with the SA01 error
################################################################################
################################## Validation ##################################
################################################################################
1 Errors found for `pandas.Timestamp.tz_localize`:
SA01 See Also section not found
Please don't comment take
as multiple people can work on this issue. You also don't need to ask for permission to work on this, just comment on which methods are you going to work.
If you're new contributor, please check the contributing guide