|
4 | 4 | ... |
5 | 5 |
|
6 | 6 |
|
| 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 | + |
7 | 37 | <a name="1.4.0"></a> |
8 | 38 | ## [1.4.0] (2020-12-05) |
9 | 39 |
|
|
76 | 106 | * Initial release |
77 | 107 |
|
78 | 108 |
|
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 |
80 | 111 | [1.4.0]: https://github.com/HunterMcGushion/docstr_coverage/compare/v1.3.0...v1.4.0 |
81 | 112 | [1.3.0]: https://github.com/HunterMcGushion/docstr_coverage/compare/v1.2.0...v1.3.0 |
82 | 113 | [1.2.0]: https://github.com/HunterMcGushion/docstr_coverage/compare/v1.1.0...v1.2.0 |
|
89 | 120 | [asergeant01]: https://github.com/asergeant01 |
90 | 121 | [cthoyt]: https://github.com/cthoyt |
91 | 122 | [econchick]: https://github.com/econchick |
| 123 | +[epassaro]: https://github.com/epassaro |
92 | 124 | [HunterMcGushion]: https://github.com/HunterMcGushion |
93 | 125 | [killthekitten]: https://github.com/killthekitten |
| 126 | +[mBouamama]: https://github.com/mBouamama |
94 | 127 | [MiWeiss]: https://github.com/MiWeiss |
95 | 128 | [Redysz]: https://github.com/Redysz |
96 | 129 | [sim0nx]: https://github.com/sim0nx |
|
106 | 139 | [#22]: https://github.com/HunterMcGushion/docstr_coverage/pull/22 |
107 | 140 | [#24]: https://github.com/HunterMcGushion/docstr_coverage/pull/24 |
108 | 141 | [#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 |
0 commit comments