Skip to content

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

Conversation

MarcoGorelli
Copy link
Member

@MarcoGorelli MarcoGorelli commented Apr 20, 2020

Another precursor to #31796, which should make it easier to review/merge


screenshots of docs

image
image
image
image

@simonjayhawkins simonjayhawkins added this to the 1.1 milestone Apr 20, 2020
Copy link
Member

@simonjayhawkins simonjayhawkins left a 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.""",
)
Copy link
Member

Choose a reason for hiding this comment

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

can you indent these

Copy link
Member

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

Copy link
Member Author

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

@WillAyd
Copy link
Member

WillAyd commented Apr 22, 2020

Lgtm - @jbrockmendel merge if happy

@jbrockmendel jbrockmendel merged commit eb965cf into pandas-dev:master Apr 22, 2020
@jbrockmendel
Copy link
Member

Thanks @MarcoGorelli

@MarcoGorelli MarcoGorelli deleted the use-subsitutions-in-info-docstrings branch April 22, 2020 16:11
rhshadrach pushed a commit to rhshadrach/pandas that referenced this pull request May 10, 2020
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants