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.

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

fix(python): Keep Series attributes docstrings when read by Sphinx #13731

Merged
merged 2 commits into from
Jan 15, 2024
Merged

fix(python): Keep Series attributes docstrings when read by Sphinx #13731

merged 2 commits into from
Jan 15, 2024

Conversation

petrosbar
Copy link
Contributor

@petrosbar petrosbar commented Jan 15, 2024 •
edited

This PR addresses the following:

  1. Fixes the overriding descriptor that prevents Sphinx from properly reading Series attributes docstrings, which in turn makes them being shown with no docstrings at all. (e.g., https://docs.pola.rs/py-polars/html/reference/series/api/polars.Series.dtype.html)
  2. Removes Series namespaces from the attributes section. Having Series namespaces shown as standalone attributes in the API section does not seem to have any usefulness. Methods accessed through these namespaces are shown anyway.

@github-actions github-actions bot added fix Bug fix python Related to Python Polars labels Jan 15, 2024
stinodego
stinodego approved these changes Jan 15, 2024
View reviewed changes
Copy link
Member

@stinodego stinodego left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good change, thanks!

@stinodego stinodego merged commit 62592d9 into pola-rs:main Jan 15, 2024
11 checks passed
@petrosbar petrosbar deleted the fix/series-attrs-docstrings branch January 15, 2024 13:00
r-brink pushed a commit to r-brink/polars that referenced this pull request Jan 15, 2024
@petrosbar @stinodego @r-brink
fix(python): Keep Series attributes docstrings when read by Sphinx (p…
1797ee4 
…ola-rs#13731)

Co-authored-by: Stijn de Gooijer <stijndegooijer@gmail.com>
r-brink pushed a commit to r-brink/polars that referenced this pull request Jan 24, 2024
@petrosbar @stinodego @r-brink
fix(python): Keep Series attributes docstrings when read by Sphinx (p…
de36548 
…ola-rs#13731)

Co-authored-by: Stijn de Gooijer <stijndegooijer@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stinodego stinodego stinodego approved these changes

@ritchie46 ritchie46 Awaiting requested review from ritchie46 ritchie46 is a code owner

@c-peters c-peters Awaiting requested review from c-peters c-peters is a code owner

@alexander-beedie alexander-beedie Awaiting requested review from alexander-beedie alexander-beedie is a code owner

@MarcoGorelli MarcoGorelli Awaiting requested review from MarcoGorelli MarcoGorelli is a code owner

Assignees
No one assigned
Labels
fix Bug fix python Related to Python Polars
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@petrosbar @stinodego