Skip to content

Commit 82b3d3f

Browse files
committed
add changelog
1 parent e645991 commit 82b3d3f

File tree

3 files changed

+82
-15
lines changed

3 files changed

+82
-15
lines changed

CHANGELOG.md

+61-11
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,52 @@
11
# Changelog
22

3+
## [v0.3.0](https://github.com/napari/magicgui/tree/v0.3.0) (2021-10-10)
4+
5+
[Full Changelog](https://github.com/napari/magicgui/compare/v0.3.0rc2...v0.3.0)
6+
7+
**Implemented enhancements:**
8+
9+
- Return type from `register_type`, so that it can be used as a decorator [\#297](https://github.com/napari/magicgui/pull/297) ([tlambert03](https://github.com/tlambert03))
10+
11+
**Deprecated:**
12+
13+
- Remove `choices` deprecation warning from 0.2.0 [\#298](https://github.com/napari/magicgui/pull/298) ([tlambert03](https://github.com/tlambert03))
14+
15+
**Merged pull requests:**
16+
17+
- add v0.3.0 migration guide [\#299](https://github.com/napari/magicgui/pull/299) ([tlambert03](https://github.com/tlambert03))
18+
19+
## [v0.3.0rc2](https://github.com/napari/magicgui/tree/v0.3.0rc2) (2021-10-10)
20+
21+
[Full Changelog](https://github.com/napari/magicgui/compare/v0.3.0rc1...v0.3.0rc2)
22+
23+
**Fixed bugs:**
24+
25+
- Allow `Signal.sender()` to work regardless of importing from magicgui or Psygnal [\#296](https://github.com/napari/magicgui/pull/296) ([tlambert03](https://github.com/tlambert03))
26+
- Catch kwargs in event emitter \(backwards compatibility with old event emitter\) [\#295](https://github.com/napari/magicgui/pull/295) ([tlambert03](https://github.com/tlambert03))
27+
28+
## [v0.3.0rc1](https://github.com/napari/magicgui/tree/v0.3.0rc1) (2021-10-04)
29+
30+
[Full Changelog](https://github.com/napari/magicgui/compare/v0.2.11...v0.3.0rc1)
31+
32+
**Implemented enhancements:**
33+
34+
- Use psygnal instead of `EventEmitter` \(callbacks receive value directly\). Add deprecation strategy [\#253](https://github.com/napari/magicgui/pull/253) ([tlambert03](https://github.com/tlambert03))
35+
36+
**Fixed bugs:**
37+
38+
- Replace underscore with spaces in checkbox label [\#293](https://github.com/napari/magicgui/pull/293) ([tlambert03](https://github.com/tlambert03))
39+
40+
**Tests & CI:**
41+
42+
- misc typing fixes and changlelog generator config [\#292](https://github.com/napari/magicgui/pull/292) ([tlambert03](https://github.com/tlambert03))
43+
44+
**Merged pull requests:**
45+
46+
- \[pre-commit.ci\] pre-commit autoupdate [\#291](https://github.com/napari/magicgui/pull/291) ([pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci))
47+
- \[pre-commit.ci\] pre-commit autoupdate [\#289](https://github.com/napari/magicgui/pull/289) ([pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci))
48+
- \[pre-commit.ci\] pre-commit autoupdate [\#287](https://github.com/napari/magicgui/pull/287) ([pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci))
49+
350
## [v0.2.11](https://github.com/napari/magicgui/tree/v0.2.11) (2021-09-11)
451

552
[Full Changelog](https://github.com/napari/magicgui/compare/v0.2.10...v0.2.11)
@@ -21,11 +68,14 @@
2168
- Fix optional annotation affecting later widgets [\#262](https://github.com/napari/magicgui/pull/262) ([tlambert03](https://github.com/tlambert03))
2269
- Fix RangeWidget with implicit optional type [\#257](https://github.com/napari/magicgui/pull/257) ([tlambert03](https://github.com/tlambert03))
2370

71+
**Tests & CI:**
72+
73+
- Fix typesafety tests [\#282](https://github.com/napari/magicgui/pull/282) ([tlambert03](https://github.com/tlambert03))
74+
2475
**Merged pull requests:**
2576

2677
- Fix docs build again [\#286](https://github.com/napari/magicgui/pull/286) ([tlambert03](https://github.com/tlambert03))
2778
- Fix docs build, add Select widget [\#285](https://github.com/napari/magicgui/pull/285) ([tlambert03](https://github.com/tlambert03))
28-
- Fix typesafety tests [\#282](https://github.com/napari/magicgui/pull/282) ([tlambert03](https://github.com/tlambert03))
2979
- update master to main [\#280](https://github.com/napari/magicgui/pull/280) ([tlambert03](https://github.com/tlambert03))
3080
- \[pre-commit.ci\] pre-commit autoupdate [\#278](https://github.com/napari/magicgui/pull/278) ([pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci))
3181
- \[pre-commit.ci\] pre-commit autoupdate [\#272](https://github.com/napari/magicgui/pull/272) ([pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci))
@@ -66,7 +116,7 @@
66116

67117
## [v0.2.9](https://github.com/napari/magicgui/tree/v0.2.9) (2021-04-05)
68118

69-
[Full Changelog](https://github.com/napari/magicgui/compare/v0.2.8...v0.2.9)
119+
[Full Changelog](https://github.com/napari/magicgui/compare/v0.2.8rc0...v0.2.9)
70120

71121
**Implemented enhancements:**
72122

@@ -89,13 +139,13 @@
89139
- skip docutils 0.17 [\#207](https://github.com/napari/magicgui/pull/207) ([tlambert03](https://github.com/tlambert03))
90140
- Add cache location hint to persist option documentation [\#200](https://github.com/napari/magicgui/pull/200) ([maweigert](https://github.com/maweigert))
91141

92-
## [v0.2.8](https://github.com/napari/magicgui/tree/v0.2.8) (2021-03-24)
142+
## [v0.2.8rc0](https://github.com/napari/magicgui/tree/v0.2.8rc0) (2021-03-24)
93143

94-
[Full Changelog](https://github.com/napari/magicgui/compare/v0.2.8rc0...v0.2.8)
144+
[Full Changelog](https://github.com/napari/magicgui/compare/v0.2.8...v0.2.8rc0)
95145

96-
## [v0.2.8rc0](https://github.com/napari/magicgui/tree/v0.2.8rc0) (2021-03-24)
146+
## [v0.2.8](https://github.com/napari/magicgui/tree/v0.2.8) (2021-03-24)
97147

98-
[Full Changelog](https://github.com/napari/magicgui/compare/v0.2.7...v0.2.8rc0)
148+
[Full Changelog](https://github.com/napari/magicgui/compare/v0.2.7...v0.2.8)
99149

100150
**Implemented enhancements:**
101151

@@ -123,7 +173,7 @@
123173

124174
## [v0.2.7](https://github.com/napari/magicgui/tree/v0.2.7) (2021-02-28)
125175

126-
[Full Changelog](https://github.com/napari/magicgui/compare/v0.2.6rc0...v0.2.7)
176+
[Full Changelog](https://github.com/napari/magicgui/compare/v0.2.6...v0.2.7)
127177

128178
**Implemented enhancements:**
129179

@@ -154,13 +204,13 @@
154204
- update changelog [\#137](https://github.com/napari/magicgui/pull/137) ([tlambert03](https://github.com/tlambert03))
155205
- \[pre-commit.ci\] pre-commit autoupdate [\#136](https://github.com/napari/magicgui/pull/136) ([pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci))
156206

157-
## [v0.2.6rc0](https://github.com/napari/magicgui/tree/v0.2.6rc0) (2021-01-25)
207+
## [v0.2.6](https://github.com/napari/magicgui/tree/v0.2.6) (2021-01-25)
158208

159-
[Full Changelog](https://github.com/napari/magicgui/compare/v0.2.6...v0.2.6rc0)
209+
[Full Changelog](https://github.com/napari/magicgui/compare/v0.2.6rc0...v0.2.6)
160210

161-
## [v0.2.6](https://github.com/napari/magicgui/tree/v0.2.6) (2021-01-25)
211+
## [v0.2.6rc0](https://github.com/napari/magicgui/tree/v0.2.6rc0) (2021-01-25)
162212

163-
[Full Changelog](https://github.com/napari/magicgui/compare/v0.2.5...v0.2.6)
213+
[Full Changelog](https://github.com/napari/magicgui/compare/v0.2.5...v0.2.6rc0)
164214

165215
**Merged pull requests:**
166216

docs/_toc.yml

+1
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,4 @@ parts:
2727
- file: api/type_map
2828
- file: api/types
2929
- file: api/v0_2_0
30+
- file: api/v0_3_0

docs/api/v0_3_0.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,20 @@ as its event/callback handler.
1111
Callbacks connected to `widget.changed` (and other event emitters) now receive the
1212
value(s) directly, instead of an event object:
1313

14+
````{admonition} **Old Method 👎**
15+
:class: danger
16+
1417
```python
15-
# before:
1618
@widget.changed.connect
1719
def my_callback(event):
1820
new_value = event.value
21+
```
22+
````
1923

20-
# now becomes
24+
````{admonition} **New Method 👍**
25+
:class: tip
26+
27+
```python
2128
@widget.changed.connect
2229
def my_callback(value):
2330
new_value = value
@@ -30,18 +37,27 @@ def my_callback():
3037
# something that didn't need the value
3138
...
3239
```
40+
````
3341

3442
## Event emitters take no keyword arguments
3543

3644
For the few packages who were manually emitting change events,
3745
you should no longer provide the `value=` keyword when emitting.
3846

47+
````{admonition} **Old Method 👎**
48+
:class: danger
49+
3950
```python
40-
# before:
4151
widget.changed(value='whatever')
52+
```
53+
````
4254

43-
# now becomes
55+
````{admonition} **New Method 👍**
56+
:class: tip
57+
58+
```python
4459
widget.changed.emit('whatever')
4560
# OR (if you prefer the direct __call__ syntax)
4661
widget.changed('whatever')
4762
```
63+
````

0 commit comments

Comments
 (0)