Skip to content

Commit

Permalink
Describe the changes in the changelog.
Browse files Browse the repository at this point in the history
  • Loading branch information
tbenthompson committed Feb 6, 2023
1 parent c9e2ce9 commit 0b65427
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
18 changes: 15 additions & 3 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
# Changelog

## Unreleased

- replaced JSON serialization with cloudpickle. This allows extracting a much wider range of objects from the notebook subprocess.
## 0.5.0

- replaced JSON serialization with cloudpickle. This allows extracting a much
wider range of objects from the notebook subprocess.
- Reference semantics have changed.
- Old behavior of `tb.get(name)` and `tb[name]`:
- a reference would be returned for non-JSON-serializable objects.
- a value would be returned for JSON-serializable objects.
- Old behavior of `tb.ref(name)` was identical to `tb.get(name)`.
- However, now almost all objects are serializable and as a result, under
the old semantics, a reference would almost never be returned. Therefore,
when a reference is desired, we now require explicitly requesting a
reference. The new behavior of `tb.get(name)` and `tb[name]` is to always
return the deserialized object and to never return a reference. The new
behavior of `tb.ref(name)` is to always return a reference.

## 0.4.2

Expand Down
1 change: 1 addition & 0 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
nbformat>=5.0.4
nbclient>=0.4.0
cloudpickle >= 2.0.0

0 comments on commit 0b65427

Please sign in to comment.