From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
by inbox.dpdk.org (Postfix) with ESMTP id 70101432C9;
Tue, 7 Nov 2023 18:38:42 +0100 (CET)
Received: from mails.dpdk.org (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id 61C8442670;
Tue, 7 Nov 2023 18:38:42 +0100 (CET)
Received: from foss.arm.com (foss.arm.com [217.140.110.172])
by mails.dpdk.org (Postfix) with ESMTP id 397904161A
for <dev@dpdk.org>; Tue, 7 Nov 2023 18:38:41 +0100 (CET)
Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14])
by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id 4B0E21476;
Tue, 7 Nov 2023 09:39:25 -0800 (PST)
Received: from [10.1.31.180] (e125442.arm.com [10.1.31.180])
by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id A010A3F6C4;
Tue, 7 Nov 2023 09:38:39 -0800 (PST)
Message-ID: <9f62a58c-39a0-4c3c-9cc1-fbc5400881b2@foss.arm.com>
Date: Tue, 7 Nov 2023 17:38:37 +0000
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH v5 02/23] dts: add docstring checker
Content-Language: en-US
To: =?UTF-8?Q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>,
thomas@monjalon.net, Honnappa.Nagarahalli@arm.com,
bruce.richardson@intel.com, jspewock@iol.unh.edu, probb@iol.unh.edu,
paul.szczepanek@arm.com
Cc: dev@dpdk.org
References: <20230831100407.59865-1-juraj.linkes@pantheon.tech>
<20231106171601.160749-1-juraj.linkes@pantheon.tech>
<20231106171601.160749-3-juraj.linkes@pantheon.tech>
From: Yoan Picchi <yoan.picchi@foss.arm.com>
In-Reply-To: <20231106171601.160749-3-juraj.linkes@pantheon.tech>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
On 11/6/23 17:15, Juraj Linkeš wrote:
> Python docstrings are the in-code way to document the code. The
> docstring checker of choice is pydocstyle which we're executing from
> Pylama, but the current latest versions are not complatible due to [0],
> so pin the pydocstyle version to the latest working version.
>
> [0] https://github.com/klen/pylama/issues/232
>
> Signed-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>
> ---
> dts/poetry.lock | 12 ++++++------
> dts/pyproject.toml | 6 +++++-
> 2 files changed, 11 insertions(+), 7 deletions(-)
>
> diff --git a/dts/poetry.lock b/dts/poetry.lock
> index f7b3b6d602..a734fa71f0 100644
> --- a/dts/poetry.lock
> +++ b/dts/poetry.lock
> @@ -489,20 +489,20 @@ files = [
>
> [[package]]
> name = "pydocstyle"
> -version = "6.3.0"
> +version = "6.1.1"
> description = "Python docstring style checker"
> optional = false
> python-versions = ">=3.6"
> files = [
> - {file = "pydocstyle-6.3.0-py3-none-any.whl", hash = "sha256:118762d452a49d6b05e194ef344a55822987a462831ade91ec5c06fd2169d019"},
> - {file = "pydocstyle-6.3.0.tar.gz", hash = "sha256:7ce43f0c0ac87b07494eb9c0b462c0b73e6ff276807f204d6b53edc72b7e44e1"},
> + {file = "pydocstyle-6.1.1-py3-none-any.whl", hash = "sha256:6987826d6775056839940041beef5c08cc7e3d71d63149b48e36727f70144dc4"},
> + {file = "pydocstyle-6.1.1.tar.gz", hash = "sha256:1d41b7c459ba0ee6c345f2eb9ae827cab14a7533a88c5c6f7e94923f72df92dc"},
> ]
>
> [package.dependencies]
> -snowballstemmer = ">=2.2.0"
> +snowballstemmer = "*"
>
> [package.extras]
> -toml = ["tomli (>=1.2.3)"]
> +toml = ["toml"]
>
> [[package]]
> name = "pyflakes"
> @@ -837,4 +837,4 @@ jsonschema = ">=4,<5"
> [metadata]
> lock-version = "2.0"
> python-versions = "^3.10"
> -content-hash = "0b1e4a1cb8323e17e5ee5951c97e74bde6e60d0413d7b25b1803d5b2bab39639"
> +content-hash = "3501e97b3dadc19fe8ae179fe21b1edd2488001da9a8e86ff2bca0b86b99b89b"
> diff --git a/dts/pyproject.toml b/dts/pyproject.toml
> index 6762edfa6b..3943c87c87 100644
> --- a/dts/pyproject.toml
> +++ b/dts/pyproject.toml
> @@ -25,6 +25,7 @@ PyYAML = "^6.0"
> types-PyYAML = "^6.0.8"
> fabric = "^2.7.1"
> scapy = "^2.5.0"
> +pydocstyle = "6.1.1"
>
> [tool.poetry.group.dev.dependencies]
> mypy = "^0.961"
> @@ -39,10 +40,13 @@ requires = ["poetry-core>=1.0.0"]
> build-backend = "poetry.core.masonry.api"
>
> [tool.pylama]
> -linters = "mccabe,pycodestyle,pyflakes"
> +linters = "mccabe,pycodestyle,pydocstyle,pyflakes"
> format = "pylint"
> max_line_length = 88 # https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#line-length
>
> +[tool.pylama.linter.pydocstyle]
> +convention = "google"
> +
> [tool.mypy]
> python_version = "3.10"
> enable_error_code = ["ignore-without-code"]
Reviewed-by: Yoan Picchi <yoan.picchi@arm.com>