Skip to content

Commit 8bb99ac

Browse files
Release v2.3.0
1 parent eb13c82 commit 8bb99ac

File tree

4 files changed

+26
-5
lines changed

4 files changed

+26
-5
lines changed

CHANGELOG.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@
44
...
55

66

7+
<a name="2.3.0"></a>
8+
## [2.3.0] (2023-04-13)
9+
10+
### Features
11+
- Display progress bar during docstring analysis. [#106] by [MiWeiss].
12+
- Add support for analyzing async functions' docstrings. [#116] by [caffeinatedMike].
13+
- Add support for Python 3.11. [#117] by [MiWeiss].
14+
15+
### Deprecations
16+
- Remove support for Python 3.6. [#117] by [MiWeiss].
17+
- Deprecate `--docstr-ignore-file` flag. [#87] by [MiWeiss].
18+
- Going forward, please use the `ignore_patterns` option in your config file
19+
- The `--docstr-ignore-file` will be removed in a future release
20+
21+
722
<a name="2.2.0"></a>
823
## [2.2.0] (2022-03-17)
924

@@ -147,7 +162,8 @@
147162
* Initial release
148163

149164

150-
[Unreleased]: https://github.com/HunterMcGushion/docstr_coverage/compare/v2.2.0...HEAD
165+
[Unreleased]: https://github.com/HunterMcGushion/docstr_coverage/compare/v2.3.0...HEAD
166+
[2.3.0]: https://github.com/HunterMcGushion/docstr_coverage/compare/v2.2.0...v2.3.0
151167
[2.2.0]: https://github.com/HunterMcGushion/docstr_coverage/compare/v2.1.1...v2.2.0
152168
[2.1.1]: https://github.com/HunterMcGushion/docstr_coverage/compare/v2.1.0...v2.1.1
153169
[2.1.0]: https://github.com/HunterMcGushion/docstr_coverage/compare/v2.0.1...v2.1.0
@@ -164,6 +180,7 @@
164180

165181
[asergeant01]: https://github.com/asergeant01
166182
[bjornconstructors]: https://github.com/bjornconstructors
183+
[caffeinatedMike]: https://github.com/caffeinatedMike
167184
[cthoyt]: https://github.com/cthoyt
168185
[econchick]: https://github.com/econchick
169186
[epassaro]: https://github.com/epassaro
@@ -198,4 +215,8 @@
198215
[#82]: https://github.com/HunterMcGushion/docstr_coverage/pull/82
199216
[#84]: https://github.com/HunterMcGushion/docstr_coverage/pull/84
200217
[#85]: https://github.com/HunterMcGushion/docstr_coverage/pull/85
201-
[#86]: https://github.com/HunterMcGushion/docstr_coverage/pull/86
218+
[#86]: https://github.com/HunterMcGushion/docstr_coverage/pull/86
219+
[#87]: https://github.com/HunterMcGushion/docstr_coverage/pull/87
220+
[#106]: https://github.com/HunterMcGushion/docstr_coverage/pull/106
221+
[#116]: https://github.com/HunterMcGushion/docstr_coverage/pull/116
222+
[#117]: https://github.com/HunterMcGushion/docstr_coverage/pull/117

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ and configuring the `paths` section of the [`.docstr.yaml` config](#config-file)
178178
```yaml
179179
repos:
180180
- repo: https://github.com/HunterMcGushion/docstr_coverage
181-
rev: v2.2.0 # most recent docstr-coverage release or commit sha
181+
rev: v2.3.0 # most recent docstr-coverage release or commit sha
182182
hooks:
183183
- id: docstr-coverage
184184
args: ["--verbose", "2"] # override the .docstr.yaml to see less output

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
author = "Hunter McGushion"
2222

2323
version = "" # The short X.Y version
24-
release = "2.2.0" # The full version, including alpha/beta/rc tags
24+
release = "2.3.0" # The full version, including alpha/beta/rc tags
2525

2626
##################################################
2727
# General Configuration

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ def readme():
66
return f.read()
77

88

9-
MAJOR, MINOR, MICRO = 2, 2, 0
9+
MAJOR, MINOR, MICRO = 2, 3, 0
1010
__VERSION__ = "{}.{}.{}".format(MAJOR, MINOR, MICRO)
1111

1212
setup(

0 commit comments

Comments
 (0)