Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cell ID JEP Implementation #189

Merged
merged 2 commits into from
Dec 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/format_description.rst
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,20 @@ keyed by filename that represents the files attached to the cell.
}


Cell ids
--------

Since the 4.5 schema release, all cells have an ``id`` field which must be a string of length
1-64 with alphanumeric, `-`, and `_` as legal characters to use. These ids must be unique to
any given Notebook following the nbformat spec.

The full rules and guidelines for using cells ids is captured in the corresponding
`JEP Proposal <https://github.com/jupyter/enhancement-proposals/blob/master/62-cell-id/cell-id.md>`_.

If attempting to add similiar support to other languages supporting notebooks specs, this
`Example PR <https://github.com/jupyter/nbformat/pull/189>`_ can be used as a reference to follow.


Backward-compatible changes
===========================

Expand Down
Empty file added nbformat/corpus/__init__.py
Empty file.
Loading