Skip to content

Commit 4ed0c73

Browse files
committed
add changelog entry for 0.31.0
also adds warning type to key param warning
1 parent e449122 commit 4ed0c73

File tree

3 files changed

+21
-2
lines changed

3 files changed

+21
-2
lines changed

Diff for: docs/source/changelog.rst

+18
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
11
Changelog
22
=========
33

4+
5+
0.30.1
6+
------
7+
8+
Removes the usage of the :func:`id` function for generating unique ideas because there
9+
were situations where the IDs bound to the lifetime of an object are problematic. Also
10+
adds a warning :class:`Deprecation` warning to render functions that include the
11+
parameter ``key``. It's been decided that allowing ``key`` to be used in this way can
12+
lead to confusing bugs.
13+
14+
**Pull Requests**
15+
16+
- warn if key is param of component render function - :pull:`421`
17+
- fix :issue:`417` and :issue:`413` - :pull:`418`
18+
- add changelog entry for :ref:`0.30.0` - :pull:`415`
19+
20+
421
0.30.0
522
------
623

@@ -44,6 +61,7 @@ desired library from a CDN.
4461
- Test build in CI - :pull:`404`
4562
- Remove all runtime reliance on NPM - :pull:`398`
4663

64+
4765
0.29.0
4866
------
4967

Diff for: docs/source/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131

3232
extlinks = {
3333
"issue": ("https://github.com/idom-team/idom/issues/%s", "#"),
34-
"pull": ("https://github.com/idom-team/idom/pulls/%s", "#"),
34+
"pull": ("https://github.com/idom-team/idom/pull/%s", "#"),
3535
"discussion": ("https://github.com/idom-team/idom/discussions/%s", "#"),
3636
"commit": ("https://github.com/idom-team/idom/commit/%s", ""),
3737
}

Diff for: src/idom/core/component.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ def component(function: ComponentRenderFunction) -> Callable[..., "Component"]:
3535
if key_is_kwarg: # pragma: no cover
3636
warnings.warn(
3737
f"Component render function {function} uses reserved parameter 'key' - this "
38-
"will produce an error in a future release"
38+
"will produce an error in a future release",
39+
DeprecationWarning,
3940
)
4041

4142
@wraps(function)

0 commit comments

Comments
 (0)