DOC: doc/source/whatsnew #36857

meghanacosmos · 2020-10-04T10:13:38Z

xref DOC: Fix code style in documentation #36777
tests added / passed
passes black pandas
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

MarcoGorelli

Nice!

doc/source/whatsnew/v0.10.0.rst

MarcoGorelli · 2020-10-04T11:52:46Z

doc/source/whatsnew/v0.17.0.rst

@@ -354,15 +362,15 @@ Some East Asian countries use Unicode characters its width is corresponding to 2

 .. ipython:: python

-   df = pd.DataFrame({u'国籍': ['UK', u'日本'], u'名前': ['Alice', u'しのぶ']})
-   df;


@dsaxton I guess the semi-colon should stay here? Might be a case of manually changing something that was changed by blacken-docs

I think so, it looks like it's being added to suppress output (there are some other cases where this is done to prevent matplotlib from printing text to the screen)

Should I add the semi-colon then? I'll let you know if I find any more like this too. @MarcoGorelli @dsaxton

yes, please do

doc/source/whatsnew/v0.9.0.rst

Co-authored-by: Marco Gorelli <[email protected]>

dsaxton · 2020-10-04T14:22:03Z

doc/source/whatsnew/v0.10.0.rst

-    data = ('a,b,c\n'
-            '1,Yes,2\n'
-            '3,No,4')
+    data = "a,b,c\n1,Yes,2\n3,No,4"


@jorisvandenbossche made the valid point that this is slightly harder to understand as an input to read_csv, so maybe we use a multiline string similar to this instead (which black is fine with):

data = """ a,b,c 1,Yes,2 3,No,4 """

What do you think @meghana-12 @MarcoGorelli ?

I'll be making changes in a min then.

This same pattern appears in several places within doc/source/user_guide/io.rst, so if you wanted to tackle those in another PR that would also be very welcome

Sure, I'll have a look at it! Are there any tools that'll help me with the issue or they need to be edited manually @dsaxton ?

MarcoGorelli · 2020-10-04T17:37:03Z

doc/source/whatsnew/v0.9.0.rst

-   data = ('0,0,1\n'
-           '1,1,0\n'
-           '0,1,0')
+   data = "0,0,1\n1,1,0\n0,1,0"


Same comment as above from doc/source/whatsnew/v0.10.0.rst (can this be written on multiple lines using """)? After this I think this'll be good to go

okay, I'll make the changes asap.

meghanacosmos · 2020-10-04T18:33:13Z

doc/source/whatsnew/v0.17.0.rst

-   pd.set_option('display.unicode.east_asian_width', True)
-   df;
+   pd.set_option("display.unicode.east_asian_width", True)
+   df


Is semi-colon need to be added here? @dsaxton @MarcoGorelli

Yeah I think we want one here too

meghanacosmos · 2020-10-04T18:37:42Z

doc/source/whatsnew/v0.19.0.rst

@@ -235,17 +246,17 @@ converting to ``Categorical`` after parsing.  See the io :ref:`docs here <io.cat

 .. ipython:: python

-   data = 'col1,col2,col3\na,b,1\na,b,2\nc,d,3'
+   data = "col1,col2,col3\na,b,1\na,b,2\nc,d,3"


I believe this can be converted into multiline too? @dsaxton @MarcoGorelli

Yes, I think that would be good

Sure. There's also a similar line in doc/source/whatsnew/v0.19.0.rst .

Just a generic comment - it doesn't seem to make a difference in these examples, but in general you'll probably want to remove the leading and trailing newlines by ending the first and last lines with \:

In [7]: data = """ ...: a,b,c ...: 1,Yes,2 ...: """ In [8]: data Out[8]: '\na,b,c\n1,Yes,2\n' In [9]: data = """\ ...: a,b,c ...: 1,Yes,2\ ...: """ In [10]: data Out[10]: 'a,b,c\n1,Yes,2'

See how the second example (starting with """\ matches the string 'a,b,c\n1,Yes,2' while the first one has extra newlines)

In these examples the extra newlines don't affect the result

In [15]: data = """\ ...: a,b,c ...: 1,Yes,2\ ...: """ In [16]: pd.read_csv(io.StringIO(data)) Out[16]: a b c 0 1 Yes 2 In [17]: data = """ ...: a,b,c ...: 1,Yes,2 ...: """ In [18]: pd.read_csv(io.StringIO(data)) Out[18]: a b c 0 1 Yes 2

so no need to add these \ here, it's just something to be aware of in case you change to multi-line format in other parts of the docs and there is does make a difference

Oh! Okay! Thank you, I'll remember that! Shall I see if the ones I updated are affected by this or not? And make changes accordingly?

Pretty sure all the ones you updated here are the same as this one (pd.read_csv(io.stringio(... so I think we're fine here

As for whether there are any tools to do this automatically - I don't think so 😢

If you update the line in line in doc/source/whatsnew/v0.19.0.rst then I think this is good to go!

Sorry, my bad, this is v0.19.0, you updated it already.

Cool, looks good to me!

dsaxton · 2020-10-05T12:58:20Z

Thanks @meghana-12

meghanacosmos · 2020-10-05T18:41:19Z

Hey, @dsaxton @MarcoGorelli I have a small request. If you find this PR good enough to be part of hacktoberfest, could you please add the label hacktoberfest-accepted?

MarcoGorelli · 2020-10-06T08:15:18Z

Happy to help, let us know if you'd like any help/mentoring with other issues

doc/source/whatsnew

01f0ba1

meghanacosmos marked this pull request as ready for review October 4, 2020 11:13

MarcoGorelli suggested changes Oct 4, 2020

View reviewed changes

meghanacosmos and others added 2 commits October 4, 2020 17:33

Update doc/source/whatsnew/v0.10.0.rst

2d2e8d8

Co-authored-by: Marco Gorelli <[email protected]>

Update doc/source/whatsnew/v0.9.0.rst

a472264

Co-authored-by: Marco Gorelli <[email protected]>

dsaxton reviewed Oct 4, 2020

View reviewed changes

meghanacosmos added 2 commits October 4, 2020 20:07

converting the single line string to multi line

c5fd403

added back a semi-colon that was removed by blacken

65a2860

MarcoGorelli reviewed Oct 4, 2020

View reviewed changes

single line string -> multiline

0a10d2a

meghanacosmos commented Oct 4, 2020

View reviewed changes

meghanacosmos added 2 commits October 5, 2020 13:20

added semi colon

6a80f9c

single line -> multi line string

d943d56

MarcoGorelli approved these changes Oct 5, 2020

View reviewed changes

dsaxton merged commit 8b00440 into pandas-dev:master Oct 5, 2020

dsaxton added hacktoberfest-accepted Docs labels Oct 5, 2020

jbrockmendel pushed a commit to jbrockmendel/pandas that referenced this pull request Oct 13, 2020

DOC: doc/source/whatsnew (pandas-dev#36857)

185d2ea

kesmit13 pushed a commit to kesmit13/pandas that referenced this pull request Nov 2, 2020

DOC: doc/source/whatsnew (pandas-dev#36857)

78d6955

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: doc/source/whatsnew #36857

DOC: doc/source/whatsnew #36857

meghanacosmos commented Oct 4, 2020 •

edited by MarcoGorelli

Loading

MarcoGorelli left a comment

MarcoGorelli Oct 4, 2020 •

edited

Loading

dsaxton Oct 4, 2020

meghanacosmos Oct 4, 2020

MarcoGorelli Oct 4, 2020

meghanacosmos Oct 4, 2020

dsaxton Oct 4, 2020

meghanacosmos Oct 4, 2020

dsaxton Oct 4, 2020

meghanacosmos Oct 4, 2020 •

edited

Loading

MarcoGorelli Oct 4, 2020 •

edited

Loading

meghanacosmos Oct 4, 2020

meghanacosmos Oct 4, 2020

dsaxton Oct 4, 2020

meghanacosmos Oct 4, 2020

dsaxton Oct 4, 2020

MarcoGorelli Oct 5, 2020 •

edited

Loading

MarcoGorelli Oct 5, 2020

meghanacosmos Oct 5, 2020

MarcoGorelli Oct 5, 2020

MarcoGorelli Oct 5, 2020

dsaxton commented Oct 5, 2020

meghanacosmos commented Oct 5, 2020 •

edited

Loading

MarcoGorelli commented Oct 6, 2020

DOC: doc/source/whatsnew #36857

DOC: doc/source/whatsnew #36857

Conversation

meghanacosmos commented Oct 4, 2020 • edited by MarcoGorelli Loading

MarcoGorelli left a comment

Choose a reason for hiding this comment

MarcoGorelli Oct 4, 2020 • edited Loading

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

meghanacosmos Oct 4, 2020 • edited Loading

Choose a reason for hiding this comment

MarcoGorelli Oct 4, 2020 • edited Loading

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

MarcoGorelli Oct 5, 2020 • edited Loading

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

dsaxton commented Oct 5, 2020

meghanacosmos commented Oct 5, 2020 • edited Loading

MarcoGorelli commented Oct 6, 2020

meghanacosmos commented Oct 4, 2020 •

edited by MarcoGorelli

Loading

MarcoGorelli Oct 4, 2020 •

edited

Loading

meghanacosmos Oct 4, 2020 •

edited

Loading

MarcoGorelli Oct 4, 2020 •

edited

Loading

MarcoGorelli Oct 5, 2020 •

edited

Loading

meghanacosmos commented Oct 5, 2020 •

edited

Loading