Skip to content

Commit a3a83c4

Browse files
committed
Format changelog closer to keep a changelog format
1 parent 89a12b7 commit a3a83c4

File tree

1 file changed

+68
-61
lines changed

1 file changed

+68
-61
lines changed

CHANGELOG.md

Lines changed: 68 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,45 @@
1-
## Unreleased
1+
# Changelog for python-asserts
22

3-
### Incompatible Changes
3+
python-asserts adheres to [semantic versioning](https://semver.org/).
44

5-
- Drop support for Python 3.7.
5+
## [Unreleased]
66

7-
## News in asserts 0.12.0
7+
### Removed
88

9-
### Incompatible Changes
9+
- Drop support for Python 3.7.
1010

11-
- Drop support for Python 3.6.
11+
## [0.12.0]
1212

13-
### API Additions
13+
### Added
1414

1515
- Add `assert_not_regex()`.
1616

17-
### Other Changes
17+
### Changed
1818

1919
- Modernize the type stubs.
2020

21-
## News in asserts 0.11.1
21+
### Removed
2222

23-
### API Additions
23+
- Drop support for Python 3.6.
24+
25+
## [0.11.1]
26+
27+
### Added
2428

2529
- `assert_json_subset()` can now check for the existence or non-existence
2630
of object members using the new `Exists` helper.
2731
- Non-string (or `Exists`) object member names in the first argument to
2832
`assert_json_subset()` now raise a `TypeError`.
2933

30-
## News in asserts 0.11.0
34+
## [0.11.0]
3135

32-
### API-Incompatible Changes
36+
### Removed
3337

3438
- Drop support for Python 2.7 and 3.5.
3539

36-
## News in asserts 0.10.0
37-
38-
### API-Incompatible Changes
40+
## [0.10.0]
3941

40-
- Drop support for Python 3.4.
41-
42-
### API Additions
42+
### Added
4343

4444
- `AssertRaisesContext` and `AssertWarnsContext` now return themselves
4545
when `__enter__()` is called. By extension it now easier to call
@@ -60,67 +60,77 @@ with assert_raises(KeyError) as context:
6060
assert_equal("expected message", str(context.exc_val))
6161
```
6262

63-
## News in asserts 0.9.1
63+
### Removed
64+
65+
- Drop support for Python 3.4.
6466

65-
### Improvements
67+
## [0.9.1]
68+
69+
### Changed
6670

6771
- `AssertRaisesContext` and sub-classes are now generic over the
6872
exception type.
6973

70-
## News in asserts 0.9.0
74+
## [0.9.0]
7175

72-
### API Additions
76+
### Added
7377

7478
- Add `assert_json_subset()`.
7579

76-
## News in asserts 0.8.6
80+
## [0.8.6]
7781

78-
### Improvements
82+
### Added
7983

8084
- Add support for Python 3.7 (contributed by Frank Niessink).
8185

82-
## News in asserts 0.8.5
86+
## [0.8.5]
8387

84-
### API Additions
88+
### Added
8589

8690
- Add `assert_dict_equal()`.
8791
- Add `assert_dict_superset()`.
8892

89-
### Improvements
93+
### Changed
9094

9195
- `assert_equal()`: Use `assert_dict_equal()` if applicable.
9296

93-
## News in asserts 0.8.4
97+
## [0.8.4]
9498

95-
### Improvements
99+
### Changed
96100

97101
- `fail()` is now marked with `NoReturn` in type stub.
98102

99-
### Bug Fixes
103+
### Fixed
100104

101105
- Improve type annotations for Python 2.
102106

103-
## News in asserts 0.8.3
107+
## [0.8.3]
104108

105-
### Bug Fixes
109+
### Fixed
106110

107111
- Fix type signature of `AssertRaisesContext.__exit__()`.
108112

109-
## News in asserts 0.8.2
113+
## [0.8.2]
110114

111-
### Improvements
115+
### Added
112116

113117
- Add a py.typed file to signal that this package supports type hints.
114118

115-
## News in asserts 0.8.1
119+
## [0.8.1]
116120

117-
### Bug Fixes
121+
### Fixed
118122

119123
- `assert_raises_regex()`: Handle exceptions without any message correctly.
120124

121-
## News in asserts 0.8.0
125+
## [0.8.0]
122126

123-
### API-Incompatible Changes
127+
### Added
128+
129+
- assert_count_equal(): Add `msg_fmt` argument.
130+
- Add AssertRaisesErrnoContext, AssertRaisesRegexContext, and
131+
AssertWarnsRegexContext.
132+
133+
### Changed
124134

125135
- Replace `msg` argument with `msg_fmt` in all assertions (except `fail()`).
126136
This allows you to customize error messages more easily than before, because
@@ -131,64 +141,61 @@ assert_equal("expected message", str(context.exc_val))
131141
- assert_almost_equal(), assert_not_almost_equal(): Place msg_fmt as third
132142
argument.
133143

134-
### API Additions
135-
136-
- assert_count_equal(): Add `msg_fmt` argument.
137-
- Add AssertRaisesErrnoContext, AssertRaisesRegexContext, and
138-
AssertWarnsRegexContext.
144+
## [0.7.3]
139145

140-
## News in asserts 0.7.3
141-
142-
### API Additions
146+
### Added
143147

144148
- Add assert_not_almost_equal().
145149

146-
### Improvements
150+
### Changed
147151

148152
- assert_almost_equal(): Raise ValueError if diff <= 0.
149153

150-
### Bug Fixes
154+
### Fixed
151155

152156
- assert_almost_equal() would never fail if a delta was supplied and the
153157
second number was smaller than the first.
154158
- Use fail() instead of raise AssertionError in a few assertions.
155159

156-
## News in asserts 0.7.2
160+
## [0.7.2]
157161

158-
### API Additions
162+
### Added
159163

160164
- Add assert_warns() and assert_warns_regex().
161165

162-
## News in asserts 0.7.1
166+
## [0.7.1]
163167

164-
- Distribute as wheel.
165-
- asserts is now a package, instead of a module.
168+
### Changed
166169

167-
## News in asserts 0.7.0
170+
- Distribute a wheel.
171+
- asserts is now a package, instead of a module.
168172

169-
- Add a stub file.
173+
## [0.7.0]
170174

171-
### API Additions
175+
### Added
172176

177+
- Add a stub file.
173178
- Add assert_count_equal().
174179

175-
## News in asserts 0.6
180+
## [0.6]
176181

177-
### API Additions
182+
### Added
178183

179184
- Add assert_less(), assert_less_equal(), assert_greater(), and
180185
assert_greater_equal().
181186
- Add assert_not_is_instance().
182187

183-
### Improvements
188+
### Changed
184189

185190
- assert_datetime_about_now()/assert_datetime_about_now_utc(): Handle
186191
comparison with None more gracefully.
187192

188-
## News in asserts 0.5.1
193+
## [0.5.1]
194+
195+
### Added
189196

190197
- Add the LICENSE file to the distribution.
191198

192-
## News in asserts 0.5
199+
## [0.5]
193200

194201
Initial release.

0 commit comments

Comments
 (0)