Skip to content

DOC: ran blacken docs tool and checked output to improve formatting #36777#36802

Merged
dsaxton merged 5 commits intopandas-dev:masterfrom
maria-ilie:fixing_code_style_in_documentation
Oct 5, 2020
Merged

DOC: ran blacken docs tool and checked output to improve formatting #36777#36802
dsaxton merged 5 commits intopandas-dev:masterfrom
maria-ilie:fixing_code_style_in_documentation

Conversation

@maria-ilie
Copy link
Copy Markdown
Contributor

@maria-ilie maria-ilie commented Oct 2, 2020

For task #36777
Ran blacken-tools on user_guide/10min.rst, user_guide/advanced.rst, basics.rst

@MarcoGorelli
Copy link
Copy Markdown
Member

MarcoGorelli commented Oct 2, 2020 •
edited
Loading

Thanks @maria-ilie ! This looks correct, it's just that E203 needs to be added to the ignore list for [flake8-rst]

Could you make the following change to setup.cfg as well? I think it's fine if it's part of this same pull request

diff --git a/setup.cfg b/setup.cfg
index 73986f692..eb2efb937 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -40,7 +40,9 @@ bootstrap =
     np  # avoiding error when importing again numpy or pandas
     pd  # (in some cases we want to do it to show users)
 ignore = E402,  # module level import not at top of file
+         E203,  # space before : (needed for how black formats slicing)
          W503,  # line break before binary operator
+         W504,  # line break after binary operator
          # Classes/functions in different blocks can generate those errors
          E302,  # expected 2 blank lines, found 0
          E305,  # expected 2 blank lines after class or function definition, found 0

(please do ask if you want/need help)

@erfannariman
Copy link
Copy Markdown
Member

erfannariman commented Oct 2, 2020

Just to be sure we don't get any conflicts, I edited 10min.rst on #36780

@dsaxton dsaxton changed the title ran blacken docs tool and checked output to improve formatting #36777 DOC: ran blacken docs tool and checked output to improve formatting #36777 Oct 2, 2020
@dsaxton dsaxton added the Docs label Oct 2, 2020
@dsaxton
Copy link
Copy Markdown
Contributor

dsaxton commented Oct 2, 2020

Thanks @maria-ilie for the PR, can you merge master to fix the conflict?

@jbrockmendel jbrockmendel added the Code Style Code style, linting, code_checks label Oct 3, 2020
MarcoGorelli
MarcoGorelli suggested changes Oct 4, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

Thanks for updating, there's just one small thing which is causing the automated checks to fail

doc/source/user_guide/10min.rst
Comment on lines +670 to +672
df = pd.DataFrame(
{"id": [1, 2, 3, 4, 5, 6], "raw_grade": ["a", "b", "b", "a", "a", "e"]}
)
Copy link
Copy Markdown
Member

@MarcoGorelli MarcoGorelli Oct 4, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

Looks like this block got extra-indented by one space, this is causing the CI error, could you move it back?

dsaxton
dsaxton approved these changes Oct 4, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@dsaxton dsaxton left a comment

Choose a reason for hiding this comment

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

Looks good, just one tiny nitpick. Also merging master should fix the CI.

@maria-ilie @dsaxton
Update doc/source/user_guide/basics.rst
9d00e5e 
Co-authored-by: Daniel Saxton <2658661+dsaxton@users.noreply.github.com>
@dsaxton dsaxton merged commit 32d79ef into pandas-dev:master Oct 5, 2020
@dsaxton
Copy link
Copy Markdown
Contributor

dsaxton commented Oct 5, 2020

Thanks @maria-ilie

@maria-ilie
Copy link
Copy Markdown
Contributor Author

maria-ilie commented Oct 5, 2020

Thanks so much for reviewing!

@maria-ilie maria-ilie deleted the fixing_code_style_in_documentation branch October 5, 2020 02:10
@MarcoGorelli MarcoGorelli mentioned this pull request Oct 5, 2020
Merged
@MarcoGorelli
Copy link
Copy Markdown
Member

MarcoGorelli commented Oct 6, 2020

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

jbrockmendel pushed a commit to jbrockmendel/pandas that referenced this pull request Oct 13, 2020
@maria-ilie @jbrockmendel
DOC: ran blacken docs tool and checked output to improve formatting p…
e5dcd98 
…andas-dev#36777 (pandas-dev#36802)
kesmit13 pushed a commit to kesmit13/pandas that referenced this pull request Nov 2, 2020
@maria-ilie
DOC: ran blacken docs tool and checked output to improve formatting p…
0ef3899 
…andas-dev#36777 (pandas-dev#36802)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@MarcoGorelli MarcoGorelli MarcoGorelli requested changes

@dsaxton dsaxton dsaxton approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Code Style Code style, linting, code_checks Docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@maria-ilie @MarcoGorelli @erfannariman @dsaxton @jbrockmendel