├── .github └── workflows │ ├── pre-release.yml │ ├── release.yml │ └── test.yml ├── .gitignore ├── .gitpod.yml ├── .pre-commit-hooks.yaml ├── .readthedocs.yaml ├── LICENSE-MIT ├── MANIFEST.in ├── Makefile ├── PULL_REQUEST_TEMPLATE.md ├── README.rst ├── docs ├── Makefile ├── conf.py ├── error_codes.rst ├── index.rst ├── license.rst ├── make.bat ├── quickstart.rst ├── release_notes.rst ├── snippets │ ├── cli.rst │ ├── config.rst │ ├── in_file.rst │ ├── install.rst │ ├── pre_commit.rst │ └── publicity.rst └── usage.rst ├── poetry.lock ├── pyproject.toml ├── requirements.txt ├── requirements ├── docs.txt ├── runtime.txt ├── test_env.txt └── tests.txt ├── src ├── __init__.py ├── pydocstyle │ ├── __init__.py │ ├── __main__.py │ ├── _version.py │ ├── checker.py │ ├── cli.py │ ├── config.py │ ├── data │ │ ├── imperatives.txt │ │ └── imperatives_blacklist.txt │ ├── parser.py │ ├── utils.py │ ├── violations.py │ └── wordlists.py └── tests │ ├── __init__.py │ ├── error_tests.py │ ├── parser_test.py │ ├── test_cases │ ├── __init__.py │ ├── all_import.py │ ├── all_import_as.py │ ├── all_import_aux.py │ ├── canonical_google_examples.py │ ├── canonical_numpy_examples.py │ ├── canonical_pep257_examples.py │ ├── capitalization.py │ ├── comment_after_def_bug.py │ ├── expected.py │ ├── functions.py │ ├── multi_line_summary_start.py │ ├── nested_class.py │ ├── noqa.py │ ├── sections.py │ ├── superfluous_quotes.py │ ├── test.py │ └── unicode_literals.py │ ├── test_decorators.py │ ├── test_definitions.py │ ├── test_integration.py │ ├── test_sphinx.py │ └── test_utils.py └── tox.ini /.github/workflows/pre-release.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/.github/workflows/pre-release.yml -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/.github/workflows/release.yml -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/.github/workflows/test.yml -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/.gitignore -------------------------------------------------------------------------------- /.gitpod.yml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/.gitpod.yml -------------------------------------------------------------------------------- /.pre-commit-hooks.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/.pre-commit-hooks.yaml -------------------------------------------------------------------------------- /.readthedocs.yaml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/.readthedocs.yaml -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/LICENSE-MIT -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include README.rst LICENSE-MIT 2 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/Makefile -------------------------------------------------------------------------------- /PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/PULL_REQUEST_TEMPLATE.md -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/README.rst -------------------------------------------------------------------------------- /docs/Makefile: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/docs/Makefile -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/docs/conf.py -------------------------------------------------------------------------------- /docs/error_codes.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/docs/error_codes.rst -------------------------------------------------------------------------------- /docs/index.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/docs/index.rst -------------------------------------------------------------------------------- /docs/license.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/docs/license.rst -------------------------------------------------------------------------------- /docs/make.bat: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/docs/make.bat -------------------------------------------------------------------------------- /docs/quickstart.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/docs/quickstart.rst -------------------------------------------------------------------------------- /docs/release_notes.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/docs/release_notes.rst -------------------------------------------------------------------------------- /docs/snippets/cli.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/docs/snippets/cli.rst -------------------------------------------------------------------------------- /docs/snippets/config.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/docs/snippets/config.rst -------------------------------------------------------------------------------- /docs/snippets/in_file.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/docs/snippets/in_file.rst -------------------------------------------------------------------------------- /docs/snippets/install.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/docs/snippets/install.rst -------------------------------------------------------------------------------- /docs/snippets/pre_commit.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/docs/snippets/pre_commit.rst -------------------------------------------------------------------------------- /docs/snippets/publicity.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/docs/snippets/publicity.rst -------------------------------------------------------------------------------- /docs/usage.rst: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/docs/usage.rst -------------------------------------------------------------------------------- /poetry.lock: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/poetry.lock -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/pyproject.toml -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/requirements.txt -------------------------------------------------------------------------------- /requirements/docs.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/requirements/docs.txt -------------------------------------------------------------------------------- /requirements/runtime.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/requirements/runtime.txt -------------------------------------------------------------------------------- /requirements/test_env.txt: -------------------------------------------------------------------------------- 1 | tox -------------------------------------------------------------------------------- /requirements/tests.txt: -------------------------------------------------------------------------------- 1 | pytest==6.2.5 2 | mypy==0.930 3 | black==22.3 4 | isort==5.4.2 5 | types-setuptools 6 | -------------------------------------------------------------------------------- /src/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/pydocstyle/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/pydocstyle/__init__.py -------------------------------------------------------------------------------- /src/pydocstyle/__main__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/pydocstyle/__main__.py -------------------------------------------------------------------------------- /src/pydocstyle/_version.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/pydocstyle/_version.py -------------------------------------------------------------------------------- /src/pydocstyle/checker.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/pydocstyle/checker.py -------------------------------------------------------------------------------- /src/pydocstyle/cli.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/pydocstyle/cli.py -------------------------------------------------------------------------------- /src/pydocstyle/config.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/pydocstyle/config.py -------------------------------------------------------------------------------- /src/pydocstyle/data/imperatives.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/pydocstyle/data/imperatives.txt -------------------------------------------------------------------------------- /src/pydocstyle/data/imperatives_blacklist.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/pydocstyle/data/imperatives_blacklist.txt -------------------------------------------------------------------------------- /src/pydocstyle/parser.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/pydocstyle/parser.py -------------------------------------------------------------------------------- /src/pydocstyle/utils.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/pydocstyle/utils.py -------------------------------------------------------------------------------- /src/pydocstyle/violations.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/pydocstyle/violations.py -------------------------------------------------------------------------------- /src/pydocstyle/wordlists.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/pydocstyle/wordlists.py -------------------------------------------------------------------------------- /src/tests/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/tests/error_tests.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/error_tests.py -------------------------------------------------------------------------------- /src/tests/parser_test.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/parser_test.py -------------------------------------------------------------------------------- /src/tests/test_cases/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/tests/test_cases/all_import.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/all_import.py -------------------------------------------------------------------------------- /src/tests/test_cases/all_import_as.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/all_import_as.py -------------------------------------------------------------------------------- /src/tests/test_cases/all_import_aux.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/all_import_aux.py -------------------------------------------------------------------------------- /src/tests/test_cases/canonical_google_examples.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/canonical_google_examples.py -------------------------------------------------------------------------------- /src/tests/test_cases/canonical_numpy_examples.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/canonical_numpy_examples.py -------------------------------------------------------------------------------- /src/tests/test_cases/canonical_pep257_examples.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/canonical_pep257_examples.py -------------------------------------------------------------------------------- /src/tests/test_cases/capitalization.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/capitalization.py -------------------------------------------------------------------------------- /src/tests/test_cases/comment_after_def_bug.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/comment_after_def_bug.py -------------------------------------------------------------------------------- /src/tests/test_cases/expected.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/expected.py -------------------------------------------------------------------------------- /src/tests/test_cases/functions.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/functions.py -------------------------------------------------------------------------------- /src/tests/test_cases/multi_line_summary_start.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/multi_line_summary_start.py -------------------------------------------------------------------------------- /src/tests/test_cases/nested_class.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/nested_class.py -------------------------------------------------------------------------------- /src/tests/test_cases/noqa.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/noqa.py -------------------------------------------------------------------------------- /src/tests/test_cases/sections.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/sections.py -------------------------------------------------------------------------------- /src/tests/test_cases/superfluous_quotes.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/superfluous_quotes.py -------------------------------------------------------------------------------- /src/tests/test_cases/test.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/test.py -------------------------------------------------------------------------------- /src/tests/test_cases/unicode_literals.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_cases/unicode_literals.py -------------------------------------------------------------------------------- /src/tests/test_decorators.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_decorators.py -------------------------------------------------------------------------------- /src/tests/test_definitions.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_definitions.py -------------------------------------------------------------------------------- /src/tests/test_integration.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_integration.py -------------------------------------------------------------------------------- /src/tests/test_sphinx.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_sphinx.py -------------------------------------------------------------------------------- /src/tests/test_utils.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/src/tests/test_utils.py -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/PyCQA/pydocstyle/HEAD/tox.ini --------------------------------------------------------------------------------