Skip to content

Commit f03d098

Browse files
Release v2.0.0
1 parent fa7eba6 commit f03d098

File tree

3 files changed

+43
-4
lines changed

3 files changed

+43
-4
lines changed

CHANGELOG.md

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

66

7+
<a name="2.0.0"></a>
8+
## [2.0.0] (2021-01-11)
9+
10+
### Features
11+
- Add `.docstr.yaml` config file. [#39] by [mBouamama].
12+
- Save docstr-coverage CLI options in `.docstr.yaml` to be used as the default configuration
13+
- For more details, see the [README's "Config File" section](https://github.com/HunterMcGushion/docstr_coverage#config-file)
14+
- Allow `ignore_patterns` to be defined in the `.docstr.yaml` config file. [#46] by [MiWeiss].
15+
- This is an alternative to the `--docstr-ignore-file` CLI option. Do not use both at the same time
16+
- Add `--accept-empty`/`-a` flag to exit with code 0 if no `.py` files are found. [#48] by [MiWeiss].
17+
- Helpful for using `docstr_coverage` in GitHub Actions as described in [#47] by [epassaro]
18+
19+
### Deprecations
20+
- Convert all CLI options to kebab-case. [#38] by [cthoyt].
21+
22+
| New | Deprecated |
23+
|--------------------|------------------|
24+
| `--fail-under` | `--failunder` |
25+
| `--follow-links` | `--followlinks` |
26+
| `--skip-class-def` | `--skipclassdef` |
27+
| `--skip-file-doc` | `--skipfiledoc` |
28+
| `--skip-init` | `--skipinit` |
29+
| `--skip-magic` | `--skipmagic` |
30+
31+
- :exclamation: **Deprecated option names will be removed in v3.0.0** :exclamation:
32+
33+
### Bug Fixes
34+
- Fix Windows compatibility issues and upgrade CI suite. [#45] by [MiWeiss].
35+
36+
737
<a name="1.4.0"></a>
838
## [1.4.0] (2020-12-05)
939

@@ -76,7 +106,8 @@
76106
* Initial release
77107

78108

79-
[Unreleased]: https://github.com/HunterMcGushion/docstr_coverage/compare/v1.4.0...HEAD
109+
[Unreleased]: https://github.com/HunterMcGushion/docstr_coverage/compare/v2.0.0...HEAD
110+
[2.0.0]: https://github.com/HunterMcGushion/docstr_coverage/compare/v1.4.0...v2.0.0
80111
[1.4.0]: https://github.com/HunterMcGushion/docstr_coverage/compare/v1.3.0...v1.4.0
81112
[1.3.0]: https://github.com/HunterMcGushion/docstr_coverage/compare/v1.2.0...v1.3.0
82113
[1.2.0]: https://github.com/HunterMcGushion/docstr_coverage/compare/v1.1.0...v1.2.0
@@ -89,8 +120,10 @@
89120
[asergeant01]: https://github.com/asergeant01
90121
[cthoyt]: https://github.com/cthoyt
91122
[econchick]: https://github.com/econchick
123+
[epassaro]: https://github.com/epassaro
92124
[HunterMcGushion]: https://github.com/HunterMcGushion
93125
[killthekitten]: https://github.com/killthekitten
126+
[mBouamama]: https://github.com/mBouamama
94127
[MiWeiss]: https://github.com/MiWeiss
95128
[Redysz]: https://github.com/Redysz
96129
[sim0nx]: https://github.com/sim0nx
@@ -106,4 +139,10 @@
106139
[#22]: https://github.com/HunterMcGushion/docstr_coverage/pull/22
107140
[#24]: https://github.com/HunterMcGushion/docstr_coverage/pull/24
108141
[#32]: https://github.com/HunterMcGushion/docstr_coverage/pull/32
109-
[#34]: https://github.com/HunterMcGushion/docstr_coverage/pull/34
142+
[#34]: https://github.com/HunterMcGushion/docstr_coverage/pull/34
143+
[#38]: https://github.com/HunterMcGushion/docstr_coverage/pull/38
144+
[#39]: https://github.com/HunterMcGushion/docstr_coverage/pull/39
145+
[#45]: https://github.com/HunterMcGushion/docstr_coverage/pull/45
146+
[#46]: https://github.com/HunterMcGushion/docstr_coverage/pull/46
147+
[#47]: https://github.com/HunterMcGushion/docstr_coverage/issues/47
148+
[#48]: https://github.com/HunterMcGushion/docstr_coverage/pull/48

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 = "1.4.0" # The full version, including alpha/beta/rc tags
24+
release = "2.0.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 = 1, 4, 0
9+
MAJOR, MINOR, MICRO = 2, 0, 0
1010
__VERSION__ = "{}.{}.{}".format(MAJOR, MINOR, MICRO)
1111

1212
setup(

0 commit comments

Comments
 (0)