Skip to content
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

DOC: GL08 errors in pandas.Timestamp #48632

Open
1 task done
Sherry3 opened this issue Sep 19, 2022 · 9 comments
Open
1 task done

DOC: GL08 errors in pandas.Timestamp #48632

Sherry3 opened this issue Sep 19, 2022 · 9 comments
Labels
Docs Timestamp pd.Timestamp and associated methods

Comments

@Sherry3
Copy link

Sherry3 commented Sep 19, 2022

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

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 Sherry3 added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Sep 19, 2022
@Sherry3
Copy link
Author

Sherry3 commented Sep 19, 2022

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

@WooilKim
Copy link

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
Copy link
Author

Sherry3 commented Sep 19, 2022

/take

@WooilKim
Copy link

@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
Copy link

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

@Sherry3
Copy link
Author

Sherry3 commented Sep 19, 2022

take

@Sherry3
Copy link
Author

Sherry3 commented Sep 19, 2022

Thank you @WooilKim.

@mroeschke mroeschke added Timestamp pd.Timestamp and associated methods and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Sep 20, 2022
@Sherry3
Copy link
Author

Sherry3 commented Sep 28, 2022

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.

@Sherry3 Sherry3 removed their assignment Sep 28, 2022
@tqa236
Copy link
Contributor

tqa236 commented Mar 10, 2024

In my opinion, this issue can be closed in favor of #57443, which has a better instruction for the workflow to fix these errors

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Timestamp pd.Timestamp and associated methods
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants