From 15e49824a8cb2a5a7ec6a6e5f273589a66f1c120 Mon Sep 17 00:00:00 2001 From: Bradley Dice Date: Fri, 29 Apr 2022 10:22:10 -0500 Subject: [PATCH] Enable pydocstyle for all packages. (#10759) Follow-up to #10748 to enable the base pydocstyle rules on all Python packages (`dask_cudf`, `cudf_kafka`, `custreamz`) and test files. Contributes to #10711, #10758. Authors: - Bradley Dice (https://github.com/bdice) Approvers: - GALI PREM SAGAR (https://github.com/galipremsagar) URL: https://github.com/rapidsai/cudf/pull/10759 --- .pre-commit-config.yaml | 6 +----- python/.flake8 | 2 +- python/custreamz/custreamz/kafka.py | 2 +- 3 files changed, 3 insertions(+), 7 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index cd7b8aea6d7..46d5223f7d3 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -65,11 +65,7 @@ repos: conda| docs| java| - notebooks| - python/dask_cudf| - python/cudf_kafka| - python/custreamz| - python/cudf/cudf/tests + notebooks ) - repo: https://github.com/pre-commit/mirrors-clang-format rev: v11.1.0 diff --git a/python/.flake8 b/python/.flake8 index 667875030cc..b763c209fc1 100644 --- a/python/.flake8 +++ b/python/.flake8 @@ -15,7 +15,7 @@ ignore = # unlike the match option above this match-dir will have no effect when # pydocstyle is invoked from pre-commit. Therefore this exclusion list must # also be maintained in the pre-commit config file. -match-dir = ^(?!(ci|cpp|conda|docs|java|notebooks|dask_cudf|cudf_kafka|custreamz|tests)).*$ +match-dir = ^(?!(ci|cpp|conda|docs|java|notebooks)).*$ # Allow missing docstrings for docutils ignore-decorators = .*(docutils|doc_apply|copy_docstring).* select = diff --git a/python/custreamz/custreamz/kafka.py b/python/custreamz/custreamz/kafka.py index f5d5031602f..0198757c68d 100644 --- a/python/custreamz/custreamz/kafka.py +++ b/python/custreamz/custreamz/kafka.py @@ -95,7 +95,7 @@ def read_gdf( message_format="json", ): - """ + r""" Read messages from the underlying KafkaDatasource connection and create a cudf Dataframe