Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/133903/?format=api
{ "id": 133903, "url": "http://patches.dpdk.org/api/patches/133903/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20231106171601.160749-3-juraj.linkes@pantheon.tech/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20231106171601.160749-3-juraj.linkes@pantheon.tech>", "list_archive_url": "https://inbox.dpdk.org/dev/20231106171601.160749-3-juraj.linkes@pantheon.tech", "date": "2023-11-06T17:15:40", "name": "[v5,02/23] dts: add docstring checker", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "0387f1a43249816b8b782d4e0b4447faa8eaa231", "submitter": { "id": 1626, "url": "http://patches.dpdk.org/api/people/1626/?format=api", "name": "Juraj Linkeš", "email": "juraj.linkes@pantheon.tech" }, "delegate": { "id": 2642, "url": "http://patches.dpdk.org/api/users/2642/?format=api", "username": "mcoquelin", "first_name": "Maxime", "last_name": "Coquelin", "email": "maxime.coquelin@redhat.com" }, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20231106171601.160749-3-juraj.linkes@pantheon.tech/mbox/", "series": [ { "id": 30173, "url": "http://patches.dpdk.org/api/series/30173/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=30173", "date": "2023-11-06T17:15:38", "name": "dts: add dts api docs", "version": 5, "mbox": "http://patches.dpdk.org/series/30173/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/133903/comments/", "check": "success", "checks": "http://patches.dpdk.org/api/patches/133903/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@inbox.dpdk.org", "Delivered-To": "patchwork@inbox.dpdk.org", "Received": [ "from mails.dpdk.org (mails.dpdk.org [217.70.189.124])\n\tby inbox.dpdk.org (Postfix) with ESMTP id ECF9F432BB;\n\tMon, 6 Nov 2023 18:16:23 +0100 (CET)", "from mails.dpdk.org (localhost [127.0.0.1])\n\tby mails.dpdk.org (Postfix) with ESMTP id 3E8A940E4A;\n\tMon, 6 Nov 2023 18:16:09 +0100 (CET)", "from mail-ej1-f47.google.com (mail-ej1-f47.google.com\n [209.85.218.47]) by mails.dpdk.org (Postfix) with ESMTP id D995140DD8\n for <dev@dpdk.org>; Mon, 6 Nov 2023 18:16:07 +0100 (CET)", "by mail-ej1-f47.google.com with SMTP id\n a640c23a62f3a-99357737980so711128166b.2\n for <dev@dpdk.org>; Mon, 06 Nov 2023 09:16:07 -0800 (PST)", "from jlinkes-PT-Latitude-5530.. (ip-46.34.243.197.o2inet.sk.\n [46.34.243.197]) by smtp.gmail.com with ESMTPSA id\n s10-20020a170906354a00b009b947aacb4bsm47016eja.191.2023.11.06.09.16.06\n (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);\n Mon, 06 Nov 2023 09:16:07 -0800 (PST)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=pantheon.tech; s=google; t=1699290967; x=1699895767; darn=dpdk.org;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:from:to:cc:subject:date\n :message-id:reply-to;\n bh=U6/AvRBkllFQ+XgMDx3380G1DrnvTmtIBIE/1+tA3H8=;\n b=H60mpiGrhHWh3/7wVS1R1rRLqzAlpuuYQmgdtVVF9XPEZWDY4CU6L4VJQfm/JpAlev\n Y0zh8tV9iHVjNXozbMP0CVr0JwhXwZWWtoLqRE/3lxl/1r9ez7tfcWHaOnVbjI2HjBj4\n HsbjEnoWJryMU7c+FTjXZwHKK9pir2R5fvmSl3R7xg86u4MkQqfEzsO1IZNtmHJbub+4\n rQfuPvBnxssqBmmCHrXbH4TXIfqPMDYc4e8bhRjxDJSM7Km1Urz4LhfxljeAV4tWAYnK\n 0U0TjuKBZCfrcPJkf64fkLfKW3joqCsSjGaituD+x2yAo95lQdLAvXC8chm1+S6e1WmB\n mPaw==", "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n d=1e100.net; s=20230601; t=1699290967; x=1699895767;\n h=content-transfer-encoding:mime-version:references:in-reply-to\n :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc\n :subject:date:message-id:reply-to;\n bh=U6/AvRBkllFQ+XgMDx3380G1DrnvTmtIBIE/1+tA3H8=;\n b=CRUJBWUVxfHnjhbAZt/t1RtsjtQ246UHeOtYm6er4Sp8SrbwEKPf3CiPn9siCJL+qn\n IOaQhewwaEsLCPZK1NWArsKUZa7PQsy9UJS4izL0qjFQxXmj1y9Cv9AfB8v0K+JpCjDC\n 6e86H1Y9Ua1RJaD3wUM66dA8dzDTxCZjrOoX5I7ZpJDmhWGecZBuSJqGfdpfC1cACL2a\n mnRTvq7Vm9Yx9L2UOeayBgBQUnSY61T6myfzdl7UXapAulippGcxmReJ2CR460Wz3y80\n 8QNUv1Idgg6UVw62RUu/1+FXZuxtZl+rGSQsRthBcu+4pcK1CLjdjS16PhAMz43CEEgG\n Mu5g==", "X-Gm-Message-State": "AOJu0Yw3yFFmA5fmZmufuypL/pT4ieJhnFoVUTSscS1uBCq7WhpO8Sfr\n rdpEsxQjFLKzekjficmxFz1Xcw==", "X-Google-Smtp-Source": "\n AGHT+IHQUZLUHPfUNVjYty5xWYC83j6NcEZIfKF7pQNdOfBrnX7DWabsUTaFvXd/dh2VyUB6R4oPvA==", "X-Received": "by 2002:a17:906:fe09:b0:994:555a:e49f with SMTP id\n wy9-20020a170906fe0900b00994555ae49fmr12921433ejb.31.1699290967616;\n Mon, 06 Nov 2023 09:16:07 -0800 (PST)", "From": "=?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "To": "thomas@monjalon.net, Honnappa.Nagarahalli@arm.com,\n bruce.richardson@intel.com, jspewock@iol.unh.edu, probb@iol.unh.edu,\n paul.szczepanek@arm.com, yoan.picchi@foss.arm.com", "Cc": "dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= <juraj.linkes@pantheon.tech>", "Subject": "[PATCH v5 02/23] dts: add docstring checker", "Date": "Mon, 6 Nov 2023 18:15:40 +0100", "Message-Id": "<20231106171601.160749-3-juraj.linkes@pantheon.tech>", "X-Mailer": "git-send-email 2.34.1", "In-Reply-To": "<20231106171601.160749-1-juraj.linkes@pantheon.tech>", "References": "<20230831100407.59865-1-juraj.linkes@pantheon.tech>\n <20231106171601.160749-1-juraj.linkes@pantheon.tech>", "MIME-Version": "1.0", "Content-Type": "text/plain; charset=UTF-8", "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>,\n <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>,\n <mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org" }, "content": "Python docstrings are the in-code way to document the code. The\ndocstring checker of choice is pydocstyle which we're executing from\nPylama, but the current latest versions are not complatible due to [0],\nso pin the pydocstyle version to the latest working version.\n\n[0] https://github.com/klen/pylama/issues/232\n\nSigned-off-by: Juraj Linkeš <juraj.linkes@pantheon.tech>\n---\n dts/poetry.lock | 12 ++++++------\n dts/pyproject.toml | 6 +++++-\n 2 files changed, 11 insertions(+), 7 deletions(-)", "diff": "diff --git a/dts/poetry.lock b/dts/poetry.lock\nindex f7b3b6d602..a734fa71f0 100644\n--- a/dts/poetry.lock\n+++ b/dts/poetry.lock\n@@ -489,20 +489,20 @@ files = [\n \n [[package]]\n name = \"pydocstyle\"\n-version = \"6.3.0\"\n+version = \"6.1.1\"\n description = \"Python docstring style checker\"\n optional = false\n python-versions = \">=3.6\"\n files = [\n- {file = \"pydocstyle-6.3.0-py3-none-any.whl\", hash = \"sha256:118762d452a49d6b05e194ef344a55822987a462831ade91ec5c06fd2169d019\"},\n- {file = \"pydocstyle-6.3.0.tar.gz\", hash = \"sha256:7ce43f0c0ac87b07494eb9c0b462c0b73e6ff276807f204d6b53edc72b7e44e1\"},\n+ {file = \"pydocstyle-6.1.1-py3-none-any.whl\", hash = \"sha256:6987826d6775056839940041beef5c08cc7e3d71d63149b48e36727f70144dc4\"},\n+ {file = \"pydocstyle-6.1.1.tar.gz\", hash = \"sha256:1d41b7c459ba0ee6c345f2eb9ae827cab14a7533a88c5c6f7e94923f72df92dc\"},\n ]\n \n [package.dependencies]\n-snowballstemmer = \">=2.2.0\"\n+snowballstemmer = \"*\"\n \n [package.extras]\n-toml = [\"tomli (>=1.2.3)\"]\n+toml = [\"toml\"]\n \n [[package]]\n name = \"pyflakes\"\n@@ -837,4 +837,4 @@ jsonschema = \">=4,<5\"\n [metadata]\n lock-version = \"2.0\"\n python-versions = \"^3.10\"\n-content-hash = \"0b1e4a1cb8323e17e5ee5951c97e74bde6e60d0413d7b25b1803d5b2bab39639\"\n+content-hash = \"3501e97b3dadc19fe8ae179fe21b1edd2488001da9a8e86ff2bca0b86b99b89b\"\ndiff --git a/dts/pyproject.toml b/dts/pyproject.toml\nindex 6762edfa6b..3943c87c87 100644\n--- a/dts/pyproject.toml\n+++ b/dts/pyproject.toml\n@@ -25,6 +25,7 @@ PyYAML = \"^6.0\"\n types-PyYAML = \"^6.0.8\"\n fabric = \"^2.7.1\"\n scapy = \"^2.5.0\"\n+pydocstyle = \"6.1.1\"\n \n [tool.poetry.group.dev.dependencies]\n mypy = \"^0.961\"\n@@ -39,10 +40,13 @@ requires = [\"poetry-core>=1.0.0\"]\n build-backend = \"poetry.core.masonry.api\"\n \n [tool.pylama]\n-linters = \"mccabe,pycodestyle,pyflakes\"\n+linters = \"mccabe,pycodestyle,pydocstyle,pyflakes\"\n format = \"pylint\"\n max_line_length = 88 # https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html#line-length\n \n+[tool.pylama.linter.pydocstyle]\n+convention = \"google\"\n+\n [tool.mypy]\n python_version = \"3.10\"\n enable_error_code = [\"ignore-without-code\"]\n", "prefixes": [ "v5", "02/23" ] }