Skip to content

DOC BUG API Reference documentation truncated for Series.unstack(), Series. #31235

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.

Sign up for GitHub

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

Jump to bottom
Closed
jpeacock29 opened this issue Jan 23, 2020 · 3 comments · Fixed by #31260
Closed

DOC BUG API Reference documentation truncated for Series.unstack(), Series. #31235

jpeacock29 opened this issue Jan 23, 2020 · 3 comments · Fixed by #31260
Labels
Docs good first issue

Comments

@jpeacock29
Copy link
Contributor

The API Reference documentation for Series and DataFrame have truncated documentation strings for Series.at_time(), Series.unstack(), and DataFrame.at_time(). The bug appears to occur where the docstring contains ". " (that is, a period followed by a space). Presumably, this pattern is being used to find the end of the one-line function description.
@jorisvandenbossche jorisvandenbossche added this to the Contributions Welcome milestone Jan 23, 2020
@jorisvandenbossche
Copy link
Member

jorisvandenbossche commented Jan 23, 2020 •
edited
Loading

@jpeacock29 indeed, I think that's a correct analysis. We should reword it a bit to avoid the . pattern. PR welcome!

@anjalis2112
Copy link
Contributor

Hello!
I would be happy to work on this.

@jorisvandenbossche
Copy link
Member

@anjalis2112 Certainly, that's welcome!

@anjalis2112 anjalis2112 mentioned this issue Jan 23, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs good first issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC fix truncated documentation for Series.unstack(), Series. anjalis2112/pandas
3 participants
@jorisvandenbossche @jpeacock29 @anjalis2112