DOC: fix docstring validation errors for `pandas.Timestamp` #59458

natmokval · 2024-08-09T11:59:24Z

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

The text was updated successfully, but these errors were encountered:

mimistiv · 2024-08-09T12:36:14Z

I will take
pandas.Timestamp.combine
pandas.Timestamp.ctime
pandas.Timestamp.date

EduardAkhmetshin · 2024-08-09T12:41:32Z

Taking replace, normalize, to_numpy, and to_period

NavaneetthaSundararaj · 2024-08-09T13:33:40Z

Listing as a checklist to tracked the tasks that are already picked

-i "pandas.Timestamp.combine PR01,SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.ctime SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.date SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.day GL08" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.fold GL08" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.fromordinal SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.fromtimestamp PR01,SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.hour GL08" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.max PR02" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.microsecond GL08" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.min PR02" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.minute GL08" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.month GL08" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.month_name SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.nanosecond GL08" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.normalize SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.quarter SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.replace PR07,SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.resolution PR02" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.second GL08" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.strptime PR01,SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.timestamp SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.timetuple SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.timetz SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.to_datetime64 SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.to_julian_date SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.to_numpy PR01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.to_period PR01,SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.today SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.toordinal SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.tz_localize SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.tzinfo GL08" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.tzname SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.unit SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.utcfromtimestamp PR01,SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.utcoffset SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.utctimetuple SA01" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.value GL08" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)
-i "pandas.Timestamp.year GL08" \ DOC: fix docstring validation errors for pandas.Timestamp #59458 (comment)

NavaneetthaSundararaj · 2024-08-09T13:37:07Z

I will take:

pandas.Timestamp.hour
pandas.Timestamp.max
pandas.Timestamp.microsecond
pandas.Timestamp.min

dnajjar · 2024-08-09T14:58:07Z

I'll take
"pandas.Timestamp.today"
"pandas.Timestamp.toordinal "

jsngn · 2024-08-09T19:12:25Z

I'll take

-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" \

zocacc · 2024-08-10T00:10:07Z

I'll take
-i "pandas.Timestamp.year GL08"
-i "pandas.Timestamp.value GL08" \

josh-tan77 · 2024-08-10T03:03:37Z

i'll take

-i pandas.Timestamp.month_name SA01
-i "pandas.Timestamp.quarter SA01

znarfm · 2024-08-10T13:24:05Z

I'll take

-i "pandas.Timestamp.fromordinal SA01"
-i "pandas.Timestamp.fromtimestamp PR01,SA01"

CICDooley · 2024-08-11T00:26:57Z

I'll take:
-i "pandas.Timestamp.minute GL08"
-i "pandas.Timestamp.month GL08"
-i "pandas.Timestamp.nanosecond GL08"
-i "pandas.Timestamp.second GL08" \

shreyas-dev · 2024-08-11T08:48:42Z

I'll take:

-i "pandas.Timestamp.unit SA01" \
 -i "pandas.Timestamp.utcoffset SA01" \
 -i "pandas.Timestamp.utctimetuple SA01"

MichaelMoyles · 2024-08-11T17:35:40Z

I'll take:
pandas.Timestamp.tz_localize
pandas.Timestamp.tzname
pandas.Timestamp.utcfromtimestamp

Blacksujit · 2024-08-13T17:56:42Z

i will take:

-i "pandas.Timestamp.utcoffset SA01"
-i "pandas.Timestamp.utctimetuple SA01" \

40gilad · 2024-08-22T09:00:38Z

ill take:
-i "pandas.Timestamp.utcfromtimestamp PR01,SA01"
-i "pandas.Timestamp.utcoffset SA01"
-i "pandas.Timestamp.utctimetuple SA01" \

40gilad · 2024-08-22T13:45:12Z

did anyone understand how it should be done? im chaning the doc of my functions in timestamp.pyx, nattype.pyx and nothing is being changed when im running scripts/validate_docstrings.py

natmokval · 2024-08-22T14:36:14Z

did anyone understand how it should be done? im chaning the doc of my functions in timestamp.pyx, nattype.pyx and nothing is being changed when im running scripts/validate_docstrings.py

@40gilad, did you rebuild pandas after your changes?
You need to compile pandas again each time the C extensions change, for example if you modified any file in pandas/_libs.
Please check the documetation "Contributing to pandas", particularly the section: build and install pandas

40gilad · 2024-08-22T16:05:05Z

did anyone understand how it should be done? im chaning the doc of my functions in timestamp.pyx, nattype.pyx and nothing is being changed when im running scripts/validate_docstrings.py

@40gilad, did you rebuild pandas after your changes? You need to compile pandas again each time the C extensions change, for example if you modified any file in pandas/_libs. Please check the documetation "Contributing to pandas", particularly the section: build and install pandas

i get:
error: command 'C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Tools\MSVC\14.38.33130\bin\HostX86\x64\link.exe' failed with exit code 1120

* adding docstring for pandas.Timestamp.day property * fixing type annotation

* adding docstring for Timestamp properties * updating code_checks.sh * removing extra line * fixing code_checks.sh

natmokval · 2024-08-30T16:28:10Z

It seems like the only method not picked is pandas.Timestamp.resolution. I will work on this method.

NavaneetthaSundararaj · 2024-08-30T19:41:44Z

I will take:

pandas.Timestamp.hour pandas.Timestamp.max pandas.Timestamp.microsecond pandas.Timestamp.min

Hour and microsecond seems to be done by #59622

add value docstring

asdkfjsd · 2024-10-10T10:12:06Z

i see those question are still on code_checks.sh
could i take

-i "pandas.Timestamp.nanosecond GL08"
-i "pandas.Timestamp.year GL08" \

mimistiv · 2024-10-10T10:33:29Z

i see those question are still on code_checks.sh could i take

-i "pandas.Timestamp.nanosecond GL08"
-i "pandas.Timestamp.year GL08" \

Hello @asdkfjsd I have a PR open for this and have been waiting for a review for a while now.
@MarcoGorelli

asdkfjsd · 2024-10-10T11:59:23Z

i see those question are still on code_checks.sh could i take

-i "pandas.Timestamp.nanosecond GL08"
-i "pandas.Timestamp.year GL08" \

Hello @asdkfjsd I have a PR open for this and have been waiting for a review for a while now. @MarcoGorelli

i'm sorry , i will find another one

amitsubhashchejara · 2024-10-20T09:05:40Z

I think all the tasks are picked already 😅.

--------- Co-authored-by: Marco Gorelli <[email protected]>

vineethsaivs · 2024-12-21T22:39:11Z

I'll take:
pandas.Timestamp.tz_localize
pandas.Timestamp.toordinal

natmokval added the Docs label Aug 9, 2024

natmokval assigned natmokval and unassigned natmokval Aug 9, 2024

natmokval added Code Style Code style, linting, code_checks good first issue labels Aug 9, 2024

github-actions bot assigned NavaneetthaSundararaj Aug 9, 2024

EduardAkhmetshin mentioned this issue Aug 9, 2024

DOC: Fix docstrings for Timestamp: normalize, replace, to_numpy, to_period #59462

Closed

5 tasks

josh-tan77 mentioned this issue Aug 10, 2024

DOC: fix docstring validation errors for pandas.Timestamp as part of Issue #59458 #59468

Closed

NavaneetthaSundararaj removed their assignment Aug 10, 2024

znarfm mentioned this issue Aug 10, 2024

DOC: Fix docstrings for Timestamp: fromordinal, fromtimestamp #59473

Closed

CICDooley mentioned this issue Aug 11, 2024

added attribute section to Timestamp docstring; added definitions of … #59476

Closed

shreyas-dev mentioned this issue Aug 11, 2024

DOC: Fix docstrings for Timestamp: unit, utcoffset, utctimetuple #59480

Closed

MichaelMoyles mentioned this issue Aug 12, 2024

DOC: Fix docstrings for Timestamp: tz_localize, tzname, utcfromtimestamp #59484

Merged

shreyas-dev mentioned this issue Aug 13, 2024

DOC: Fix docstrings for Timestamp: unit, utcoffset, utctimetuple #59496

Merged

This was referenced Aug 14, 2024

Fix docstrings for pandas.Period.month #59517

Merged

Fix docstrings for pandas.Period.year SA01 #59525

Merged

Fix docstring timestamps#59458 #59533

Merged

NavaneetthaSundararaj mentioned this issue Aug 23, 2024

Changes to fix docstring issue with pandas.Timestamp.max and min #59512

Closed

ankit-dhokariya mentioned this issue Aug 24, 2024

DOC: Enforce Numpy Docstring Validation (Issue #59458) #59590

Merged

5 tasks

natmokval mentioned this issue Aug 24, 2024

DOC: fix docstring validation errors for pandas.Series #59592

Open

mroeschke pushed a commit that referenced this issue Aug 25, 2024

DOC: Enforce Numpy Docstring Validation (Issue #59458) (#59590)

2130a99

* adding docstring for pandas.Timestamp.day property * fixing type annotation

hlakams mentioned this issue Aug 26, 2024

DOC: fix docstring validation errors for pandas.io.formats.style.Styler #59606

Closed

1 task

ankit-dhokariya mentioned this issue Aug 27, 2024

DOC: Enforce Numpy Docstring Validation (Issue #59458) #59622

Merged

5 tasks

mroeschke pushed a commit that referenced this issue Aug 27, 2024

DOC: Enforce Numpy Docstring Validation (Issue #59458) (#59622)

5700efe

* adding docstring for Timestamp properties * updating code_checks.sh * removing extra line * fixing code_checks.sh

uditbaliyan mentioned this issue Aug 28, 2024

Docstring timestamps#59458 #59644

Merged

mimistiv mentioned this issue Sep 2, 2024

DOC: Fix docstring timestamps (Issue #59458) #59688

Merged

5 tasks

natmokval mentioned this issue Sep 3, 2024

DOC: fix docstring validation errors for pandas.Timedelta/pandas.TimedeltaIndex #59698

Open

mimistiv mentioned this issue Sep 3, 2024

Fix docstring timestamps (Issue #59458) #59701

Merged

5 tasks

mroeschke pushed a commit that referenced this issue Sep 3, 2024

Fix docstring timestamps (Issue #59458) (#59701)

197e8db

add value docstring

NavaneetthaSundararaj mentioned this issue Sep 7, 2024

Doc string for pandas.Timestamp.max, pandas.Timestamp.min #59744

Closed

EduardAkhmetshin added a commit to EduardAkhmetshin/pandas that referenced this issue Sep 10, 2024

Merge remote-tracking branch 'upstream/main' into pandas-devgh-59458

2518c93

MarcoGorelli added a commit that referenced this issue Nov 11, 2024

Fix docstring timestamps (Issue #59458) (#59688)

156e67e

--------- Co-authored-by: Marco Gorelli <[email protected]>

knowltod mentioned this issue Dec 6, 2024

DOC: Fix some core.resample.Resampler docstrings #60502

Open

karnbirrandhawa mentioned this issue Dec 7, 2024

DOC: fix SA01 for pandas.arrays.NumpyExtensionArray #60513

Open

This was referenced Dec 15, 2024

DOC: fix docstring validation errors for pandas.core and pandas.errors #60575

Closed

DOC: fix docstring validation errors for pandas.core and pandas.errors #60576

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: fix docstring validation errors for `pandas.Timestamp` #59458

DOC: fix docstring validation errors for `pandas.Timestamp` #59458

natmokval commented Aug 9, 2024 •

edited

Loading

mimistiv commented Aug 9, 2024

EduardAkhmetshin commented Aug 9, 2024 •

edited

Loading

NavaneetthaSundararaj commented Aug 9, 2024 •

edited

Loading

NavaneetthaSundararaj commented Aug 9, 2024

dnajjar commented Aug 9, 2024

jsngn commented Aug 9, 2024

zocacc commented Aug 10, 2024 •

edited

Loading

josh-tan77 commented Aug 10, 2024

znarfm commented Aug 10, 2024

CICDooley commented Aug 11, 2024

shreyas-dev commented Aug 11, 2024 •

edited

Loading

MichaelMoyles commented Aug 11, 2024

Blacksujit commented Aug 13, 2024 •

edited

Loading

40gilad commented Aug 22, 2024

40gilad commented Aug 22, 2024

natmokval commented Aug 22, 2024

40gilad commented Aug 22, 2024

natmokval commented Aug 30, 2024

NavaneetthaSundararaj commented Aug 30, 2024

asdkfjsd commented Oct 10, 2024

mimistiv commented Oct 10, 2024

asdkfjsd commented Oct 10, 2024

amitsubhashchejara commented Oct 20, 2024

vineethsaivs commented Dec 21, 2024

DOC: fix docstring validation errors for pandas.Timestamp #59458

DOC: fix docstring validation errors for pandas.Timestamp #59458

Comments

natmokval commented Aug 9, 2024 • edited Loading

mimistiv commented Aug 9, 2024

EduardAkhmetshin commented Aug 9, 2024 • edited Loading

NavaneetthaSundararaj commented Aug 9, 2024 • edited Loading

NavaneetthaSundararaj commented Aug 9, 2024

dnajjar commented Aug 9, 2024

jsngn commented Aug 9, 2024

zocacc commented Aug 10, 2024 • edited Loading

josh-tan77 commented Aug 10, 2024

znarfm commented Aug 10, 2024

CICDooley commented Aug 11, 2024

shreyas-dev commented Aug 11, 2024 • edited Loading

MichaelMoyles commented Aug 11, 2024

Blacksujit commented Aug 13, 2024 • edited Loading

40gilad commented Aug 22, 2024

40gilad commented Aug 22, 2024

natmokval commented Aug 22, 2024

40gilad commented Aug 22, 2024

natmokval commented Aug 30, 2024

NavaneetthaSundararaj commented Aug 30, 2024

asdkfjsd commented Oct 10, 2024

mimistiv commented Oct 10, 2024

asdkfjsd commented Oct 10, 2024

amitsubhashchejara commented Oct 20, 2024

vineethsaivs commented Dec 21, 2024

DOC: fix docstring validation errors for `pandas.Timestamp` #59458

DOC: fix docstring validation errors for `pandas.Timestamp` #59458

natmokval commented Aug 9, 2024 •

edited

Loading

EduardAkhmetshin commented Aug 9, 2024 •

edited

Loading

NavaneetthaSundararaj commented Aug 9, 2024 •

edited

Loading

zocacc commented Aug 10, 2024 •

edited

Loading

shreyas-dev commented Aug 11, 2024 •

edited

Loading

Blacksujit commented Aug 13, 2024 •

edited

Loading