Skip to content

Commit

Permalink
add changelog entry for 0.31.0
Browse files Browse the repository at this point in the history
also adds warning type to key param warning
  • Loading branch information
rmorshea committed Jul 13, 2021
1 parent e449122 commit 4ed0c73
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 2 deletions.
18 changes: 18 additions & 0 deletions docs/source/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,23 @@
Changelog
=========


0.30.1
------

Removes the usage of the :func:`id` function for generating unique ideas because there
were situations where the IDs bound to the lifetime of an object are problematic. Also
adds a warning :class:`Deprecation` warning to render functions that include the
parameter ``key``. It's been decided that allowing ``key`` to be used in this way can
lead to confusing bugs.

**Pull Requests**

- warn if key is param of component render function - :pull:`421`
- fix :issue:`417` and :issue:`413` - :pull:`418`
- add changelog entry for :ref:`0.30.0` - :pull:`415`


0.30.0
------

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


0.29.0
------

Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

extlinks = {
"issue": ("https://github.com/idom-team/idom/issues/%s", "#"),
"pull": ("https://github.com/idom-team/idom/pulls/%s", "#"),
"pull": ("https://github.com/idom-team/idom/pull/%s", "#"),
"discussion": ("https://github.com/idom-team/idom/discussions/%s", "#"),
"commit": ("https://github.com/idom-team/idom/commit/%s", ""),
}
Expand Down
3 changes: 2 additions & 1 deletion src/idom/core/component.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ def component(function: ComponentRenderFunction) -> Callable[..., "Component"]:
if key_is_kwarg: # pragma: no cover
warnings.warn(
f"Component render function {function} uses reserved parameter 'key' - this "
"will produce an error in a future release"
"will produce an error in a future release",
DeprecationWarning,
)

@wraps(function)
Expand Down

0 comments on commit 4ed0c73

Please sign in to comment.