From 64c616d2c44d5fa61a92d103195832fa5a9631b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Noord?= <13665637+DanielNoord@users.noreply.github.com> Date: Wed, 4 May 2022 16:48:43 +0200 Subject: [PATCH 1/6] Specify objective of project in README --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b317ecd6..d546502d 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,27 @@ # Pydocstringformatter -A tool to automatically format Python docstrings that tries to follow recommendations +A tool to automatically format Python docstrings to follow recommendations from [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) and -[`PEP 257`](https://www.python.org/dev/peps/pep-0257/). See -[What it does](#what-it-does) for currently supported auto-formatting. +[`PEP 257`](https://www.python.org/dev/peps/pep-0257/). + +See [What it does](#what-it-does) for currently supported auto-formatting. + +### Rationale + +This project is heavily inspired by [`docformatter`](https://github.com/PyCQA/docformatter). + +When this project was started `docformatter` did not meet all of the requirements the +[`pylint`](https://github.com/PyCQA/pylint) project had for its docstring formatter and sadly `docformatter` +is now also no longer fully supported. +Therefore, some contributors of `pylint` got together and started working on our own formatter to fulfill +our needs. + +When asked they defined the objective of the tools as: + +_"A docstring formatter that follows PEP8 and PEP257 but makes some of the more 'controversial' elements of the PEPs optional"_ + +See [the original answer](https://github.com/DanielNoord/pydocstringformatter/issues/38). ## How to install From 902391c20d17920bcc380c16c96c0d5c76696b8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Noord?= <13665637+DanielNoord@users.noreply.github.com> Date: Wed, 4 May 2022 16:49:47 +0200 Subject: [PATCH 2/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d546502d..db1ac896 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ is now also no longer fully supported. Therefore, some contributors of `pylint` got together and started working on our own formatter to fulfill our needs. -When asked they defined the objective of the tools as: +When asked we defined the objective of the tools as: _"A docstring formatter that follows PEP8 and PEP257 but makes some of the more 'controversial' elements of the PEPs optional"_ From 5940e2b5d012cff4ca9e6ddd7e7993777d418db0 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 4 May 2022 14:50:09 +0000 Subject: [PATCH 3/6] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index db1ac896..6f42dd9e 100644 --- a/README.md +++ b/README.md @@ -6,27 +6,29 @@ # Pydocstringformatter -A tool to automatically format Python docstrings to follow recommendations -from [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) and -[`PEP 257`](https://www.python.org/dev/peps/pep-0257/). +A tool to automatically format Python docstrings to follow recommendations from +[`PEP 8`](https://www.python.org/dev/peps/pep-0008/) and +[`PEP 257`](https://www.python.org/dev/peps/pep-0257/). See [What it does](#what-it-does) for currently supported auto-formatting. ### Rationale -This project is heavily inspired by [`docformatter`](https://github.com/PyCQA/docformatter). +This project is heavily inspired by +[`docformatter`](https://github.com/PyCQA/docformatter). -When this project was started `docformatter` did not meet all of the requirements the -[`pylint`](https://github.com/PyCQA/pylint) project had for its docstring formatter and sadly `docformatter` -is now also no longer fully supported. -Therefore, some contributors of `pylint` got together and started working on our own formatter to fulfill -our needs. +When this project was started `docformatter` did not meet all of the requirements the +[`pylint`](https://github.com/PyCQA/pylint) project had for its docstring formatter and +sadly `docformatter` is now also no longer fully supported. Therefore, some contributors +of `pylint` got together and started working on our own formatter to fulfill our needs. When asked we defined the objective of the tools as: -_"A docstring formatter that follows PEP8 and PEP257 but makes some of the more 'controversial' elements of the PEPs optional"_ +_"A docstring formatter that follows PEP8 and PEP257 but makes some of the more +'controversial' elements of the PEPs optional"_ -See [the original answer](https://github.com/DanielNoord/pydocstringformatter/issues/38). +See +[the original answer](https://github.com/DanielNoord/pydocstringformatter/issues/38). ## How to install From 7f6e3481f92672979771108f2cecbe4ac9b05f46 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Noord?= <13665637+DanielNoord@users.noreply.github.com> Date: Wed, 4 May 2022 16:56:33 +0200 Subject: [PATCH 4/6] Apply suggestions from code review --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6f42dd9e..cb8680f5 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ When this project was started `docformatter` did not meet all of the requirement sadly `docformatter` is now also no longer fully supported. Therefore, some contributors of `pylint` got together and started working on our own formatter to fulfill our needs. -When asked we defined the objective of the tools as: +When asked we defined the objective of the tool as: _"A docstring formatter that follows PEP8 and PEP257 but makes some of the more 'controversial' elements of the PEPs optional"_ @@ -30,6 +30,10 @@ _"A docstring formatter that follows PEP8 and PEP257 but makes some of the more See [the original answer](https://github.com/DanielNoord/pydocstringformatter/issues/38). +As such, the biggest difference between the two is that `pydocstringformatter` +fixes some of the open issues we found in `docformatter`. In general, the output +of both formatters (and any other docstring formatter) should be relatively the same. + ## How to install ```shell From c162d22d66fba5757463ddd22fb8304bdfd5c963 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 4 May 2022 14:57:02 +0000 Subject: [PATCH 5/6] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cb8680f5..19cfe72e 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,9 @@ _"A docstring formatter that follows PEP8 and PEP257 but makes some of the more See [the original answer](https://github.com/DanielNoord/pydocstringformatter/issues/38). -As such, the biggest difference between the two is that `pydocstringformatter` -fixes some of the open issues we found in `docformatter`. In general, the output -of both formatters (and any other docstring formatter) should be relatively the same. +As such, the biggest difference between the two is that `pydocstringformatter` fixes +some of the open issues we found in `docformatter`. In general, the output of both +formatters (and any other docstring formatter) should be relatively the same. ## How to install From bbc42e18ff9522f234538f7050ee7e53d1a725f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Noord?= <13665637+DanielNoord@users.noreply.github.com> Date: Wed, 4 May 2022 16:57:35 +0200 Subject: [PATCH 6/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 19cfe72e..02cdf53e 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ See As such, the biggest difference between the two is that `pydocstringformatter` fixes some of the open issues we found in `docformatter`. In general, the output of both -formatters (and any other docstring formatter) should be relatively the same. +formatters (and any other docstring formatter) should be relatively similar. ## How to install