DOC: Fix DataFrame.to_csv docstring and add an example. GH22459 #22475
Conversation
|
Travis fails due to a curl error. |
pandas/core/generic.py
Outdated
| encoding : string, optional | ||
| A string representing the encoding to use in the output file, | ||
| defaults to 'ascii' on Python 2 and 'utf-8' on Python 3. | ||
| compression : {'infer', 'gzip', 'bz2', 'zip', 'xz', None}, |
There was a problem hiding this comment.
Think the domain of potential values should remain here - was this causing some type of validation error?
There was a problem hiding this comment.
In fact the length of the potential values plus the default value span on two lines with the 80 characters limit. This leads to the following error:
Parameter "compression" description should start with a capital letter.
There was a problem hiding this comment.
Do you mind changing the parameter types, so they are Python types when possible (str, bool, int...) please? In case of list you can use something like list of str. The default can stay at the end, but things like that the length of a string should be 1, should go into the description.
pandas/core/generic.py
Outdated
| Examples | ||
| -------- | ||
|
|
||
| >>> df = pd.DataFrame({'col1': [1], 'col2': ['a'], 'col3': [10.1]}) |
There was a problem hiding this comment.
Can you make the example a bit more meaningful? So, data looks real, and is easier to understand.
Also, can you remove the blank line before this line?
pandas/core/generic.py
Outdated
|
|
||
| See Also | ||
| -------- | ||
| pandas.read_csv : load a CSV file into a DataFrame |
There was a problem hiding this comment.
can you also add DataFrame.to_excel?
And make the See Also description start with capital and finish with period.
…section to DataFrame.to_csv docstring
Codecov Report
@@ Coverage Diff @@
## master #22475 +/- ##
=======================================
Coverage 92.04% 92.04%
=======================================
Files 169 169
Lines 50787 50787
=======================================
Hits 46745 46745
Misses 4042 4042
Continue to review full report at Codecov.
|
pandas/core/generic.py
Outdated
| The order of arguments for Series was changed. | ||
| Returns | ||
| ------- | ||
| If path_or_buf is None, returns the resulting csv format as a string. |
There was a problem hiding this comment.
Can you add a line first None or str and then this description in the next line indented
pandas/core/generic.py
Outdated
| Examples | ||
| -------- | ||
| >>> df = pd.DataFrame({'name': ['Raphael', 'Donatello'], | ||
| ... 'mask': ['red', 'purple'], 'weapon': ['sai', 'bo staff']}) |
There was a problem hiding this comment.
can you indent mask at the level of name and weapon in the next line with the same indentation
|
circleci |
|
@Moisan do you mind updating you branch with master (i.e. The fail in the build is unrelated to your changes, but doesn't seem it reruns when I trigger it from the web interface. |
|
@WillAyd please merge when you're happy with this |
|
Thanks @Moisan |
|
BTW, sphinx requires a blank line before a |
git diff upstream/master -u -- "*.py" | flake8 --diffFix the DataFrame.to_csv docstring to match
scripts/validate_docstrings.pyas explained in #22459. I also added an example. Is the whatsnew entry needed for documentation too?