-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
CLN,TYP: Use subsitutions in info docstrings #33673
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
CLN,TYP: Use subsitutions in info docstrings #33673
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @MarcoGorelli lgtm
DataFrame.describe: Generate descriptive statistics of DataFrame | ||
columns. | ||
DataFrame.memory_usage: Memory usage of DataFrame columns.""", | ||
) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you indent these
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
or keep the text adjacent to the implementation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jbrockmendel that's a good suggestion - have indented
…ngs' into use-subsitutions-in-info-docstrings
Lgtm - @jbrockmendel merge if happy |
Thanks @MarcoGorelli |
* add subs in info.py * substitute docstring in frame.py * Add type annotations * reinstate data parameter * revert removed line * indent docstring * fix validation of docstrings * fix indentation of max_columns
Another precursor to #31796, which should make it easier to review/merge
screenshots of docs