Skip to content
This repository was archived by the owner on Nov 3, 2023. It is now read-only.

Commit ab1f974

Browse files
sambhavsambhav
authored
Merge branch 'master' into benji/add-sphinx-style-parameters
2 parents a0c68ab + 302bb78 commit ab1f974

24 files changed

+379
-106
lines changed

‎.bumpversion.cfg

-18
This file was deleted.

‎.github/workflows/pre-release.yml

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Test PyPI publish
3+
4+
on:
5+
release:
6+
types: [prereleased]
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
environment: pypi-dev
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v3
15+
16+
- name: Install poetry
17+
run: pipx install poetry
18+
19+
- name: Setup Python
20+
uses: actions/setup-python@v3
21+
with:
22+
python-version: "3.7"
23+
cache: "poetry"
24+
25+
- name: Install dependencies
26+
run: |
27+
poetry env use "3.7"
28+
poetry install
29+
poetry config repositories.testpypi https://test.pypi.org/legacy/
30+
31+
- name: Bump version number
32+
run: poetry version ${{ github.event.release.tag_name }}
33+
34+
- name: Build package
35+
run: poetry build
36+
37+
- name: Publish package
38+
run: poetry publish -r testpypi -u __token__ -p ${{ secrets.TEST_PYPI_PASSWORD }}

‎.github/workflows/release.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: PyPI publish
3+
4+
on:
5+
release:
6+
types: [released]
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
environment: pypi-prod
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v3
15+
16+
- name: Install poetry
17+
run: pipx install poetry
18+
19+
- name: Setup Python
20+
uses: actions/setup-python@v3
21+
with:
22+
python-version: "3.7"
23+
cache: "poetry"
24+
25+
- name: Install dependencies
26+
run: |
27+
poetry env use "3.7"
28+
poetry install
29+
30+
- name: Bump version number
31+
run: poetry version ${{ github.event.release.tag_name }}
32+
33+
- name: Build package
34+
run: poetry build
35+
36+
- name: Publish package
37+
run: poetry publish -u __token__ -p ${{ secrets.PYPI_PASSWORD }}

‎.github/workflows/test.yml

+11-5
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
11
name: Run tests
22

3-
on: [push, pull_request]
4-
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
branches:
9+
- master
510
jobs:
611
test-latest:
712
runs-on: ${{ matrix.os }}
813
strategy:
14+
fail-fast: false
915
matrix:
1016
os: [macos-latest, ubuntu-latest, windows-latest]
11-
python-version: ["3.7", "3.8", "3.9", "3.10"]
17+
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
1218

1319
steps:
14-
- uses: actions/checkout@v2
20+
- uses: actions/checkout@v3
1521
- name: Set up Python ${{ matrix.python-version }}
16-
uses: actions/setup-python@v2
22+
uses: actions/setup-python@v4
1723
with:
1824
python-version: ${{ matrix.python-version }}
1925
- name: Install tox

‎Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ format:
55
black src/pydocstyle
66

77
tests:
8-
tox -e py,install,docs
8+
tox -e py,install

‎README.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Run
6363
Develop
6464
^^^^^^^
6565

66-
You can use Gitpod to run pre-configured dev envrionment in the cloud right from your browser -
66+
You can use Gitpod to run pre-configured dev environment in the cloud right from your browser -
6767

6868
.. image:: https://gitpod.io/button/open-in-gitpod.svg
6969
:target: https://gitpod.io/#https://github.com/PyCQA/pydocstyle
@@ -74,8 +74,8 @@ Before submitting a PR make sure that you run `make all`.
7474
Links
7575
-----
7676

77-
* `Read the full documentation here <http://pydocstyle.org/en/stable/>`_.
77+
* `Read the full documentation here <https://pydocstyle.org/en/stable/>`_.
7878

79-
* `Fork pydocstyle on GitHub <http://github.com/PyCQA/pydocstyle>`_.
79+
* `Fork pydocstyle on GitHub <https://github.com/PyCQA/pydocstyle>`_.
8080

8181
* `PyPI project page <https://pypi.python.org/pypi/pydocstyle>`_.

‎docs/index.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ docstring conventions.
88
`PEP 257 <http://www.python.org/dev/peps/pep-0257/>`_ out of the box, but it
99
should not be considered a reference implementation.
1010

11-
**pydocstyle** supports Python 3.6, 3.7 and 3.8.
11+
**pydocstyle** supports Python 3.7 through 3.11.
12+
13+
Although pydocstyle is tries to be compatible with Python 3.6, it is not tested.
1214

1315

1416
.. include:: quickstart.rst

‎docs/release_notes.rst

+22-1
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,29 @@ Release Notes
44
**pydocstyle** version numbers follow the
55
`Semantic Versioning <http://semver.org/>`_ specification.
66

7+
6.2.3 - January 8th, 2023
8+
---------------------------
9+
10+
Bug Fixes
11+
12+
* Fix decorator parsing for async function. Resolves some false positives
13+
with async functions and ``overload``. (#577)
14+
15+
6.2.2 - January 3rd, 2023
16+
---------------------------
17+
18+
Bug Fixes
19+
20+
* Fix false positives of D417 in google convention docstrings (#619).
21+
22+
6.2.1 - January 3rd, 2023
23+
---------------------------
24+
25+
Bug Fixes
26+
27+
* Use tomllib/tomli to correctly read .toml files (#599, #600).
728

8-
Current Development Version
29+
6.2.0 - January 2nd, 2023
930
---------------------------
1031

1132
New Features

‎poetry.lock

+82
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pyproject.toml

+36
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,39 @@
1+
[tool.poetry]
2+
name = "pydocstyle"
3+
version = "0.0.0-dev"
4+
description = "Python docstring style checker"
5+
authors = ["Amir Rachum <[email protected]>", "Sambhav Kothari <[email protected]"]
6+
license = "MIT"
7+
readme = "README.rst"
8+
documentation = "https://www.pydocstyle.org/en/stable/"
9+
homepage = "https://www.pydocstyle.org/en/stable/"
10+
repository = "https://github.com/PyCQA/pydocstyle"
11+
classifiers = [
12+
"Intended Audience :: Developers",
13+
"Environment :: Console",
14+
"Development Status :: 5 - Production/Stable",
15+
"Operating System :: OS Independent"
16+
]
17+
18+
[tool.poetry.urls]
19+
"Release Notes" = "https://www.pydocstyle.org/en/stable/release_notes.html"
20+
21+
[tool.poetry.dependencies]
22+
python = ">=3.6"
23+
snowballstemmer = ">=2.2.0"
24+
tomli = {version = ">=1.2.3", optional = true, python = "<3.11"}
25+
importlib-metadata = {version = ">=2.0.0,<5.0.0", python = "<3.8"}
26+
27+
[tool.poetry.extras]
28+
toml = ["tomli"]
29+
30+
[tool.poetry.scripts]
31+
pydocstyle = "pydocstyle.cli:main"
32+
33+
[build-system]
34+
requires = ["poetry-core"]
35+
build-backend = "poetry.core.masonry.api"
36+
137
[tool.black]
238
line-length = 79
339
target-version = ['py36']

‎requirements/docs.txt

+4-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1+
Jinja2
2+
sphinx
13
sphinx_rtd_theme
2-
# Pinned to 1.6.2 due to a bug in 1.6.3. See GitHub PR #270 for details.
3-
# TODO: remove this restriction once 1.6.4 or later is released.
4-
sphinx==1.6.2
5-
# Pinned to 3.0.3 to prevent an issue with Sphinx
6-
# See https://github.com/PyCQA/pydocstyle/pull/585
7-
Jinja2==3.0.3
4+
# adding . so that pydocstyle gets installed
5+
.

‎requirements/runtime.txt

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
1-
snowballstemmer==1.2.1
2-
toml==0.10.2
1+
snowballstemmer>=1.2.1
2+
tomli>=1.2.3; python_version < "3.11"
3+
importlib-metadata<5.0.0,>=2.0.0; python_version < "3.8"

‎requirements/tests.txt

-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,4 @@ pytest==6.2.5
22
mypy==0.930
33
black==22.3
44
isort==5.4.2
5-
types-toml
65
types-setuptools

‎setup.py

-53
This file was deleted.

0 commit comments

Comments
 (0)