Skip to content

ENH/DOC: Cleanup docstrings on NDFrame #5052

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

Merged

Conversation

jtratner
Copy link
Contributor

Resolves much of #4717. Basically cleans up docstrings in a few places
plus, for the few functions that need them, uses a shared dict of
function definitions to share them. This has the side-benefit of letting
the function docstrings reside right next to the functions themselves,
maintaining readability.

@jtratner
Copy link
Contributor Author

@jreback what do you think? I think this is nicely succinct and easy to follow.

@@ -802,8 +817,8 @@ def to_clipboard(self):
-----
Requirements for your platform
- Linux: xclip, or xsel (with gtk or PyQt4 modules)
- Windows:
- OS X:
- Windows: [not yet supported]
Copy link
Contributor

Choose a reason for hiding this comment

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

windows just find, AFAIK Mac too that's the point of pyperclip

@jreback
Copy link
Contributor

jreback commented Sep 30, 2013

find by me (just those clipboard comments) above

@jtratner
Copy link
Contributor Author

so it's just pyperclip for OSX/Windows?

@jreback
Copy link
Contributor

jreback commented Sep 30, 2013

pyperclip IIRC tries various methods eg xclip,xsel, qt on Linux; native access in windows and says it works on Mac which I think was verified

it is included in pandas/utils IIRC

jtratner added a commit that referenced this pull request Oct 1, 2013
@jtratner jtratner merged commit d24bd9f into pandas-dev:master Oct 1, 2013
@jtratner jtratner deleted the update-docstrings-as-appropriate branch October 1, 2013 04:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants