search

pandas-dev / pandas

Flexible and powerful data analysis / manipulation library for Python, providing labeled data structures similar to R data.frame objects, statistical functions, and much more
https://pandas.pydata.org
BSD 3-Clause "New" or "Revised" License
43.4k stars 17.83k forks source link

DOC: GL08 errors in pandas.Timestamp #48632

Open Sherry3 opened 2 years ago

Sherry3 commented 2 years ago

Pandas version checks

Location of the documentation

https://pandas.pydata.org/docs/reference/api/pandas.Timestamp.html https://pandas.pydata.org/docs/reference/api/pandas.Timestamp.day.html https://pandas.pydata.org/docs/reference/api/pandas.Timestamp.fold.html https://pandas.pydata.org/docs/reference/api/pandas.Timestamp.hour.html https://pandas.pydata.org/docs/reference/api/pandas.Timestamp.microsecond.html https://pandas.pydata.org/docs/reference/api/pandas.Timestamp.minute.html https://pandas.pydata.org/docs/reference/api/pandas.Timestamp.month.html https://pandas.pydata.org/docs/reference/api/pandas.Timestamp.nanosecond.html https://pandas.pydata.org/docs/reference/api/pandas.Timestamp.second.html https://pandas.pydata.org/docs/reference/api/pandas.Timestamp.tzinfo.html https://pandas.pydata.org/docs/reference/api/pandas.Timestamp.value.html https://pandas.pydata.org/docs/reference/api/pandas.Timestamp.year.html https://pandas.pydata.org/docs/reference/api/pandas.Timestamp.freq.html

Documentation problem

Below are the GL08 errors in pandas.Timestamp: -

None:None:GL08:pandas.Timestamp.day:The object does not have a docstring
None:None:GL08:pandas.Timestamp.fold:The object does not have a docstring
None:None:GL08:pandas.Timestamp.hour:The object does not have a docstring
None:None:GL08:pandas.Timestamp.microsecond:The object does not have a docstring
None:None:GL08:pandas.Timestamp.minute:The object does not have a docstring
None:None:GL08:pandas.Timestamp.month:The object does not have a docstring
None:None:GL08:pandas.Timestamp.nanosecond:The object does not have a docstring
None:None:GL08:pandas.Timestamp.second:The object does not have a docstring
None:None:GL08:pandas.Timestamp.tzinfo:The object does not have a docstring
None:None:GL08:pandas.Timestamp.value:The object does not have a docstring
None:None:GL08:pandas.Timestamp.year:The object does not have a docstring
None:None:GL08:pandas.Timestamp.freq:The object does not have a docstring

Suggested fix for documentation

Adding description and examples. Similar to week.

week Return the week number of the year.

https://pandas.pydata.org/docs/reference/api/pandas.Timestamp.week.html

Sherry3 commented 2 years ago

I have created this issue to start my open source journey. May I please take up this task?

WooilKim commented 2 years ago

Hi. @Sherry3 In the pandas repo, if you write /take in a comment of an issue or PR, it will be assigned to you.

Sherry3 commented 2 years ago

/take

WooilKim commented 2 years ago

@Sherry3 I'm sorry but it seems to be not working. I copied and pasted the advice from #48598 . I'll comment if I get the right way to be assigned.

WooilKim commented 2 years ago

@Sherry3 Can you try to comment just "take" without slash? I think it works.

Sherry3 commented 2 years ago

take

Sherry3 commented 2 years ago

Thank you @WooilKim.

Sherry3 commented 2 years ago

I am unassigning myself from this ticket, so that others can take it. Right now I don't know how to fix it. In case I find a way, I will assign it to myself again.

tqa236 commented 6 months ago

In my opinion, this issue can be closed in favor of https://github.com/pandas-dev/pandas/issues/57443, which has a better instruction for the workflow to fix these errors