DOC: update the pandas.core.generic.NDFrame.to_clipboard docstring #20134

dandxy89 · 2018-03-10T13:45:57Z

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

PR title is "DOC: update the docstring"
The validation script passes: scripts/validate_docstrings.py pandas.core.generic.NDFrame.to_clipboard
The PEP8 style check passes: git diff upstream/master -u -- "*.py" | flake8 --diff
The html version looks good: python doc/make.py --single pandas.core.generic.NDFrame.to_clipboard
It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

################################################################################
############# Docstring (pandas.core.generic.NDFrame.to_clipboard) #############
################################################################################

Copy object to the system clipboard.

Write a text representation of object to the system clipboard.
This can be pasted into Excel, for example.

Parameters
----------
excel : bool
    Default setting for this argument is True.
    If True, use the provided separator, writing in a csv format for
    allowing easy pasting into excel.
    If False, write a string representation of the object to the
    clipboard.
sep : str, default tab
    Field delimiter.
kwargs : optional
    These parameters will be passed to either
    :py:meth:`pandas.DataFrame.to_csv`
    or :py:meth:`pandas.Series.to_csv` methods depending on the
    Object type.

See Also
--------
pandas.core.frame.DataFrame.to_csv : Write a DataFrame to a
    comma-separated values (csv) file.
pandas.core.series.Series.to_csv : Write a Series to a
    comma-separated values (csv) file.

Notes
-----
Requirements for your platform.
  - Linux : `xclip`, or `xsel` (with `gtk` or `PyQt4` modules)
  - Windows : none
  - OS X : none

Examples
--------
Copy the contents of a DataFrame to the clipboard.

>>> df = pd.DataFrame([[1, 2, 3], [4, 5, 6]], columns=['A', 'B', 'C'])
>>> df.to_clipboard()

We can omit the the index by passing the keyword 'index' and setting it to false.

>>> df.to_clipboard(index=False)

################################################################################
################################## Validation ##################################
################################################################################

If the validation script still gives errors, but you think there is a good reason
to deviate in this case (and there are certainly such cases), please state this
explicitly.

pep8speaks · 2018-03-10T14:42:58Z

Hello @dandxy89! Thanks for updating the PR.

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated on March 13, 2018 at 20:48 Hours UTC

jreback · 2018-03-10T16:07:11Z

pandas/core/generic.py

-        other keywords are passed to to_csv
+        excel : bool
+            Default setting for this argument is True.
+            If True, use the provided separator, writing in a csv format for


@jorisvandenbossche I think we indenting or '-' here to separate these cases?

Depends on the context, in this case for True/False I think it is fine as sentences (but if there are more options certainly better to explicitly use lists)

Don't think we have a policy. But I think

- True : use the provided separator,... - False : ...

looks nice.

jreback · 2018-03-10T16:07:35Z

pandas/core/generic.py

+            Field delimiter.
+        kwargs : optional
+            These parameters will be passed to either
+            :py:meth:`pandas.DataFrame.to_csv`


don't need the ':py:' prefix

TomAugspurger · 2018-03-10T16:14:03Z

pandas/core/generic.py

-                to the clipboard
-        sep : optional, defaults to tab
-        other keywords are passed to to_csv
+        excel : bool


Default would go on this line. so bool, default True.

TomAugspurger · 2018-03-10T16:15:26Z

pandas/core/generic.py

+
+        See Also
+        --------
+        pandas.core.frame.DataFrame.to_csv : Write a DataFrame to a


Just DataFrame.to_csv

TomAugspurger · 2018-03-10T16:15:33Z

pandas/core/generic.py

+        --------
+        pandas.core.frame.DataFrame.to_csv : Write a DataFrame to a
+            comma-separated values (csv) file.
+        pandas.core.series.Series.to_csv : Write a Series to a


Just Series.to_csv

jorisvandenbossche

Thanks for the PR! Added some more comments

jorisvandenbossche · 2018-03-10T16:10:56Z

pandas/core/generic.py

-                to the clipboard
-        sep : optional, defaults to tab
-        other keywords are passed to to_csv
+        excel : bool


please leave the default: bool, default True

jorisvandenbossche · 2018-03-10T16:12:59Z

pandas/core/generic.py

-        other keywords are passed to to_csv
+        excel : bool
+            Default setting for this argument is True.
+            If True, use the provided separator, writing in a csv format for


Depends on the context, in this case for True/False I think it is fine as sentences (but if there are more options certainly better to explicitly use lists)

jorisvandenbossche · 2018-03-10T16:13:57Z

pandas/core/generic.py

+            clipboard.
+        sep : str, default tab
+            Field delimiter.
+        kwargs : optional


kwargs : optional -> **kwargs

jorisvandenbossche · 2018-03-10T16:14:46Z

pandas/core/generic.py

+            These parameters will be passed to either
+            :py:meth:`pandas.DataFrame.to_csv`
+            or :py:meth:`pandas.Series.to_csv` methods depending on the
+            Object type.


Since they actually have the same optional keyword, I would just refer to DataFrame.to_csv to keep it a bit shorter

jorisvandenbossche · 2018-03-10T16:15:33Z

pandas/core/generic.py

+
+        See Also
+        --------
+        pandas.core.frame.DataFrame.to_csv : Write a DataFrame to a


pandas.core.frame.DataFrame.to_csv -> DataFrame.to_csv (same below)

would also refer to read_clipboard

TomAugspurger · 2018-03-10T16:16:16Z

pandas/core/generic.py

+        >>> df.to_clipboard()
+
+        We can omit the the index by passing the keyword 'index' and setting
+         it to false.


Remove the leading space here.

TomAugspurger · 2018-03-10T16:16:35Z

pandas/core/generic.py

+        >>> df = pd.DataFrame([[1, 2, 3], [4, 5, 6]], columns=['A', 'B', 'C'])
+        >>> df.to_clipboard()
+
+        We can omit the the index by passing the keyword 'index' and setting


backticks for "index" instead of quotes

dandxy89 · 2018-03-10T17:49:55Z

@jreback ready for a review.

codecov · 2018-03-13T20:48:52Z

Codecov Report

Merging #20134 into master will decrease coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #20134      +/-   ##
==========================================
- Coverage   91.72%    91.7%   -0.03%     
==========================================
  Files         150      150              
  Lines       49156    49152       -4     
==========================================
- Hits        45090    45074      -16     
- Misses       4066     4078      +12

Flag	Coverage Δ
#multiple	`90.08% <ø> (-0.03%)`	⬇️
#single	`41.84% <ø> (-0.01%)`	⬇️

Impacted Files	Coverage Δ
pandas/core/generic.py	`95.84% <ø> (ø)`	⬆️
pandas/plotting/_converter.py	`65.07% <0%> (-1.74%)`	⬇️
pandas/core/base.py	`96.78% <0%> (-0.02%)`	⬇️
pandas/core/series.py	`93.85% <0%> (-0.01%)`	⬇️
pandas/core/indexes/base.py	`96.66% <0%> (-0.01%)`	⬇️
pandas/core/indexes/multi.py	`95.06% <0%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 840d432...ea10208. Read the comment docs.

TomAugspurger · 2018-03-13T20:49:30Z

Used the same trick as DtypeWarning for showing the "output" of to_clipboard.

Thanks @dandxy89!

dandxy89 added 5 commits March 10, 2018 13:38

Docstring updated: to_clipboard (London)

f12a1c0

Fixing the Flake8 warnings

90d655e

Fixing validation warnings

13a3764

Emitting return type

10305d8

Updating based on Feedback within sprint

790ab6e

Fixing PEP8 issues

2961ab1

jreback requested changes Mar 10, 2018

View reviewed changes

jreback added Docs Output-Formatting __repr__ of pandas objects, to_string labels Mar 10, 2018

TomAugspurger reviewed Mar 10, 2018

View reviewed changes

jorisvandenbossche reviewed Mar 10, 2018

View reviewed changes

TomAugspurger reviewed Mar 10, 2018

View reviewed changes

Updating - post-review

aaed5ca

TomAugspurger added 2 commits March 13, 2018 15:47

Updated

3f4e7ce

Formatting on tab

ea10208

TomAugspurger added this to the 0.23.0 milestone Mar 13, 2018

TomAugspurger merged commit 74bf0d0 into pandas-dev:master Mar 13, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: update the pandas.core.generic.NDFrame.to_clipboard docstring #20134

DOC: update the pandas.core.generic.NDFrame.to_clipboard docstring #20134

dandxy89 commented Mar 10, 2018 •

edited

Loading

pep8speaks commented Mar 10, 2018 •

edited

Loading

jreback Mar 10, 2018

jorisvandenbossche Mar 10, 2018

TomAugspurger Mar 10, 2018

jreback Mar 10, 2018

TomAugspurger Mar 10, 2018

TomAugspurger Mar 10, 2018

TomAugspurger Mar 10, 2018

jorisvandenbossche left a comment

jorisvandenbossche Mar 10, 2018

jorisvandenbossche Mar 10, 2018

jorisvandenbossche Mar 10, 2018

jorisvandenbossche Mar 10, 2018

jorisvandenbossche Mar 10, 2018

TomAugspurger Mar 10, 2018

TomAugspurger Mar 10, 2018

dandxy89 commented Mar 10, 2018

codecov bot commented Mar 13, 2018

TomAugspurger commented Mar 13, 2018

DOC: update the pandas.core.generic.NDFrame.to_clipboard docstring #20134

DOC: update the pandas.core.generic.NDFrame.to_clipboard docstring #20134

Conversation

dandxy89 commented Mar 10, 2018 • edited Loading

pep8speaks commented Mar 10, 2018 • edited Loading

Comment last updated on March 13, 2018 at 20:48 Hours UTC

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorisvandenbossche left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dandxy89 commented Mar 10, 2018

codecov bot commented Mar 13, 2018

Codecov Report

TomAugspurger commented Mar 13, 2018

dandxy89 commented Mar 10, 2018 •

edited

Loading

pep8speaks commented Mar 10, 2018 •

edited

Loading