Skip to content

Commit 0b65427

Browse files
committed
Describe the changes in the changelog.
1 parent c9e2ce9 commit 0b65427

File tree

2 files changed

+16
-3
lines changed

2 files changed

+16
-3
lines changed

docs/changelog.md

+15-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,20 @@
11
# Changelog
22

3-
## Unreleased
4-
5-
- replaced JSON serialization with cloudpickle. This allows extracting a much wider range of objects from the notebook subprocess.
3+
## 0.5.0
4+
5+
- replaced JSON serialization with cloudpickle. This allows extracting a much
6+
wider range of objects from the notebook subprocess.
7+
- Reference semantics have changed.
8+
- Old behavior of `tb.get(name)` and `tb[name]`:
9+
- a reference would be returned for non-JSON-serializable objects.
10+
- a value would be returned for JSON-serializable objects.
11+
- Old behavior of `tb.ref(name)` was identical to `tb.get(name)`.
12+
- However, now almost all objects are serializable and as a result, under
13+
the old semantics, a reference would almost never be returned. Therefore,
14+
when a reference is desired, we now require explicitly requesting a
15+
reference. The new behavior of `tb.get(name)` and `tb[name]` is to always
16+
return the deserialized object and to never return a reference. The new
17+
behavior of `tb.ref(name)` is to always return a reference.
618

719
## 0.4.2
820

requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
nbformat>=5.0.4
22
nbclient>=0.4.0
3+
cloudpickle >= 2.0.0

0 commit comments

Comments
 (0)