Coding Style Guidline.rst #34608

Stockfoot · 2020-06-05T19:49:06Z

Created a unified version of the Coding Style Guidelines
Extracted rules from various pandas website information as well as submission scripts that verify style requirements
Work in progress

closes DOC: Single Document For Code Guidelines #33851
tests added / passed
passes black pandas
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

Created a unified version of the Coding Style Guidelines Extracted rules from various pandas website information as well as submission scripts that verify style requirements Work in progress

WillAyd · 2020-06-09T03:21:36Z

This just duplicates what is already on the docs right? If so I think can just update the existing contributing guide with links rather than a new file with copied content

Stockfoot · 2020-06-12T15:24:58Z

This just duplicates what is already on the docs right? If so I think can just update the existing contributing guide with links rather than a new file with copied content

This doesn't just copy what is in the docs.

This is just the start of the doc and I did pull information scattered in multiple locations about coding guidelines. I also started to pull out checks that are done in the script that check for coding guidelines that are not described anywhere.

If this document becomes more robust it think that it would be a useful tool for the OSS project.

Stockfoot · 2020-06-12T15:26:28Z

I am also unsure of how to fix the CI/Checks error. It is saying there is a trailing white space after all my lines which do no show up in my IDE

WillAyd

OK thanks. So for things that are enforced by black I don't think we need to go into details as the tool just does these things for you.

We still need to figure out how to manage this versus existing documentation we have, but if you can trim down by removing the black sections should make it easier to iterate

WillAyd · 2020-06-15T19:08:44Z

Coding Style Guidline.rst

+2.1 Line Length
+~~~~~~~~~~~~~~~
+
+Line length is restricted to 80 characters to promote readability.


We use a line length of 88

WillAyd · 2020-06-15T19:11:30Z

Coding Style Guidline.rst

+
+Line length is restricted to 80 characters to promote readability.
+
+2.2 Indentation


I think this is enforced by black; no need to detail here

WillAyd · 2020-06-15T19:11:37Z

Coding Style Guidline.rst

+    if x == 3
+     x = 10
+
+2.3 Whitespaces Around Arithmetic Operators


same for comment around black

WillAyd · 2020-06-15T19:11:44Z

Coding Style Guidline.rst

+
+   x=3+5/2
+
+2.4 Missing White Spaces After Commas


same for black

WillAyd · 2020-06-15T19:12:20Z

Coding Style Guidline.rst

+
+   myFunctionCall('a','b','c')
+
+2.5 Header File


Is this a Python reference?

WillAyd · 2020-06-15T19:13:07Z

Coding Style Guidline.rst

+   value = str
+   f"Unknown recived type, got: '{type(value).__name__}'"
+
+4 Types


OK so this is already in the contributing guideline. If we want to move here then should remove from that so as not to duplicate

Stockfoot · 2020-06-18T21:52:44Z

@WillAyd I'll trim those out and resubmit, thank you for your help!

Stockfoot · 2020-06-22T16:47:52Z

@WillAyd I have updated those sections. Let me know if there is anything else that I could research/add

Stockfoot · 2020-06-23T15:36:07Z

@WillAyd I am also unsure of how to get past the CI / Checks portion of the pull request. It is saying there is a trailing white space after every line but in my IDE this is not there.

WillAyd

I think the trailing whitespace might be a false positive from not having the code-block directives explicitly declared

WillAyd · 2020-06-23T16:10:40Z

Coding Style Guidline.rst

+
+**Good:**
+
+::


Can you make these code-block:: python directives?

WillAyd · 2020-06-23T16:10:55Z

Coding Style Guidline.rst

+2 Patterns
+----------
+
+2.1 Header File


What is this in reference to? This isn't anything Python related right? I think should just remove

WillAyd · 2020-06-23T16:11:50Z

Coding Style Guidline.rst

+   import numpy as np
+   import pandas as pd
+
+4.1.2 Unused Imports


Since this is enforced by flake8 already I don't think need to call out here

WillAyd · 2020-06-23T16:12:42Z

Coding Style Guidline.rst

+
+   maybe_primes: List[Union[int, None]] = []
+
+4.1.1 Redundant Imports


This is strictly for writing documentation, but for general code style it is certainly OK to import these. I think can just remove this from this guide

@WillAyd I made those changes you requested, but it still seems like it is failing after ever carriage line return

jbrockmendel · 2020-08-18T18:04:39Z

The section on repr can probably go, since we mostly use fstrings now.

WillAyd · 2020-09-10T19:03:39Z

@Stockfoot still active? If so can you simplify and address comments?

Stockfoot · 2020-09-10T23:40:45Z

@WillAyd I am still around.
I am just unsure of how to proceed. The CI/Check seems to fail no matter what I do.
I have made all the changes that were previously suggested. The only one I need to address is the most recent with @jbrockmendel

The section on repr can probably go, since we mostly use fstrings now.

github-actions · 2020-10-12T00:15:52Z

This pull request is stale because it has been open for thirty days with no activity. Please update or respond to this comment if you're still interested in working on this.

arw2019

@Stockfoot are you interested in continuing? If yes if you can address comments & merge master we'll take another look

Stockfoot · 2020-11-05T19:20:08Z

@arw2019 I am interested in continuing. I have addressed the comments but no one has ever responded back to my question on how to proceed and actually get a pull request going.

Every time I try and submit it will no pass CI / Checks and am unsure how to proceed...

arw2019 · 2020-11-05T19:34:44Z

Can you merge master again and I'll take a look (output from the last build is no longer available for inspection). Some failures are random but we want to make sure otherwise will have to address

Also I might be wrong but I don't think you responded to https://github.com/pandas-dev/pandas/pull/34608/files#r440389770

arw2019 · 2020-11-27T03:54:42Z

Closing for now. @Stockfoot let us know whenever you'd like to pick this up and we'll reopen

Coding Style Guidline.rst

fb03eef

Created a unified version of the Coding Style Guidelines Extracted rules from various pandas website information as well as submission scripts that verify style requirements Work in progress

WillAyd reviewed Jun 15, 2020

View reviewed changes

Removed Sections Enforced by Black

c726a00

WillAyd requested changes Jun 23, 2020

View reviewed changes

Removed Sections and Changed Code Block Directives

0967eca

rhshadrach added the Docs label Sep 11, 2020

github-actions bot added the Stale label Oct 12, 2020

arw2019 reviewed Nov 5, 2020

View reviewed changes

arw2019 closed this Nov 27, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Coding Style Guidline.rst #34608

Coding Style Guidline.rst #34608

Stockfoot commented Jun 5, 2020

WillAyd commented Jun 9, 2020

Stockfoot commented Jun 12, 2020

Stockfoot commented Jun 12, 2020

WillAyd left a comment

WillAyd Jun 15, 2020

WillAyd Jun 15, 2020

WillAyd Jun 15, 2020

WillAyd Jun 15, 2020

WillAyd Jun 15, 2020

WillAyd Jun 15, 2020

Stockfoot commented Jun 18, 2020

Stockfoot commented Jun 22, 2020

Stockfoot commented Jun 23, 2020

WillAyd left a comment

WillAyd Jun 23, 2020

WillAyd Jun 23, 2020

WillAyd Jun 23, 2020

WillAyd Jun 23, 2020

Stockfoot Jul 2, 2020

jbrockmendel commented Aug 18, 2020

WillAyd commented Sep 10, 2020

Stockfoot commented Sep 10, 2020

github-actions bot commented Oct 12, 2020

arw2019 left a comment

Stockfoot commented Nov 5, 2020

arw2019 commented Nov 5, 2020

arw2019 commented Nov 27, 2020


		Line length is restricted to 80 characters to promote readability.

		2.2 Indentation


		maybe_primes: List[Union[int, None]] = []

		4.1.1 Redundant Imports


		Good:

		::

Coding Style Guidline.rst #34608

Coding Style Guidline.rst #34608

Conversation

Stockfoot commented Jun 5, 2020

WillAyd commented Jun 9, 2020

Stockfoot commented Jun 12, 2020

Stockfoot commented Jun 12, 2020

WillAyd 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

Stockfoot commented Jun 18, 2020

Stockfoot commented Jun 22, 2020

Stockfoot commented Jun 23, 2020

WillAyd 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

jbrockmendel commented Aug 18, 2020

WillAyd commented Sep 10, 2020

Stockfoot commented Sep 10, 2020

github-actions bot commented Oct 12, 2020

arw2019 left a comment

Choose a reason for hiding this comment

Stockfoot commented Nov 5, 2020

arw2019 commented Nov 5, 2020

arw2019 commented Nov 27, 2020