jupyter / jupyter/nbformat

Missing documentation

Open
#219 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
313
Forks
176
PR merge metrics
No merged PRs in 30d

Description

For the latest version of the documentation (for nbformat 5.1.3), the following is either lacking or missing:

1. **nbformat.v4.upgrade** is not documented, but very useful for upgrading to the latest minor version of the v4 format. Notably, I was having the issue of adding new cells to a notebook using the 4.2 format, which made the notebook format invalid, because the different `v4.new_cell` methods adds a cell id which is incompatible with the <4.5 formats, and there is no way to specify a minor version when adding new cells.
2. **nbformat.v4.upgrade** returns the upgraded notebook whenever the notebook is modified, but returns `None` otherwise. Based on the least surprise principle, this is not the best strategy in my opinion. It would be better to always return the notebook, or at least to make this behavior explicit in the documentation.
3. The arguments of the **nbformat.validate** method are not currently documented, and some of them are not obvious.

Contributor guide

Open the contributing guide

Research direction

Start by locating the documentation for nbformat.v4.upgrade and nbformat.validate, then compare it with their current APIs. Done means documenting upgrade, including its return behavior, and documenting the arguments of validate; the issue does not name specific files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.