jupyter / jupyter/nbformat

kernelspec and kernel_info

Open
#188 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

Hi,

I'm reading the docs for v4.4 where it mentions that kernel information is stored under the "kernel_info" key: https://nbformat.readthedocs.io/en/4.4.0/format_description.html#top-level-structure

However, the JSON spec does not mention this section, but rather a "kernelspec" section: https://github.com/jupyter/nbformat/blob/master/nbformat/v4/nbformat.v4.4.schema.json

Is this an error in the docs?

Contributor guide

Open the contributing guide

Research direction

Compare the v4.4 format documentation at the linked top-level-structure section with nbformat/v4/nbformat.v4.4.schema.json. Determine whether “kernel_info” versus “kernelspec” is a documentation error or an intentional distinction, then make the documentation and schema terminology consistent or explain the distinction clearly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.