From 42490facb194ccb5afa035cdb87908cad2730059 Mon Sep 17 00:00:00 2001 From: Raisa Dzhamtyrova Date: Sun, 16 Feb 2020 18:48:52 +0000 Subject: [PATCH 1/5] Mention black and PEP8 in pandas style guide --- doc/source/development/code_style.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/source/development/code_style.rst b/doc/source/development/code_style.rst index bcddc033a61f5..b09e1fa34d499 100644 --- a/doc/source/development/code_style.rst +++ b/doc/source/development/code_style.rst @@ -128,6 +128,11 @@ For example: value = str f"Unknown received type, got: '{type(value).__name__}'" +PEP8 / black +-------------------------------------- +pandas follows the PEP8 standard and uses Black and Flake8 to ensure a +consistent code format throughout the project. For details see the +contributing guide https://pandas.pydata.org/pandas-docs/stable/development/contributing.html#python-pep8-black. Imports (aim for absolute) ========================== From fda18fc2faec521314144e4d3f40f30e17cd6518 Mon Sep 17 00:00:00 2001 From: Raisa Dzhamtyrova Date: Sun, 16 Feb 2020 19:22:47 +0000 Subject: [PATCH 2/5] remove white spaces --- doc/source/development/code_style.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/source/development/code_style.rst b/doc/source/development/code_style.rst index b09e1fa34d499..5dbb844d16722 100644 --- a/doc/source/development/code_style.rst +++ b/doc/source/development/code_style.rst @@ -129,9 +129,9 @@ For example: f"Unknown received type, got: '{type(value).__name__}'" PEP8 / black --------------------------------------- -pandas follows the PEP8 standard and uses Black and Flake8 to ensure a -consistent code format throughout the project. For details see the +------------ +pandas follows the PEP8 standard and uses Black and Flake8 to ensure a +consistent code format throughout the project. For details see the contributing guide https://pandas.pydata.org/pandas-docs/stable/development/contributing.html#python-pep8-black. Imports (aim for absolute) From 25b99cf6ebecc478aa1aeddc932183f087d8b8bf Mon Sep 17 00:00:00 2001 From: Raisa Dzhamtyrova Date: Mon, 17 Feb 2020 10:15:19 +0000 Subject: [PATCH 3/5] add links --- doc/source/development/code_style.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/source/development/code_style.rst b/doc/source/development/code_style.rst index 5dbb844d16722..782899efc525b 100644 --- a/doc/source/development/code_style.rst +++ b/doc/source/development/code_style.rst @@ -9,6 +9,13 @@ pandas code style guide .. contents:: Table of contents: :local: +*pandas* follows the `PEP8 `_ +standard and uses `Black `_ +and `Flake8 `_ to ensure a +consistent code format throughout the project. For details see the +`contributing guide to pandas +`_. + Patterns ======== @@ -128,12 +135,6 @@ For example: value = str f"Unknown received type, got: '{type(value).__name__}'" -PEP8 / black ------------- -pandas follows the PEP8 standard and uses Black and Flake8 to ensure a -consistent code format throughout the project. For details see the -contributing guide https://pandas.pydata.org/pandas-docs/stable/development/contributing.html#python-pep8-black. - Imports (aim for absolute) ========================== From 8696e2afe20ebfe3010f4fc15422bc1c1c835dfa Mon Sep 17 00:00:00 2001 From: Raisa Dzhamtyrova Date: Mon, 17 Feb 2020 10:47:29 +0000 Subject: [PATCH 4/5] change link to contributing guide --- doc/source/development/code_style.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/source/development/code_style.rst b/doc/source/development/code_style.rst index 782899efc525b..f6056e2daa982 100644 --- a/doc/source/development/code_style.rst +++ b/doc/source/development/code_style.rst @@ -13,8 +13,7 @@ pandas code style guide standard and uses `Black `_ and `Flake8 `_ to ensure a consistent code format throughout the project. For details see the -`contributing guide to pandas -`_. +:ref:`contributing guide to pandas`. Patterns ======== From 57a781812170085cfb96be282b252703b6f1b472 Mon Sep 17 00:00:00 2001 From: Raisa Dzhamtyrova Date: Mon, 17 Feb 2020 10:59:12 +0000 Subject: [PATCH 5/5] restore a line --- doc/source/development/code_style.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/source/development/code_style.rst b/doc/source/development/code_style.rst index f6056e2daa982..17f8783f71bfb 100644 --- a/doc/source/development/code_style.rst +++ b/doc/source/development/code_style.rst @@ -134,6 +134,7 @@ For example: value = str f"Unknown received type, got: '{type(value).__name__}'" + Imports (aim for absolute) ==========================