nbformat icon indicating copy to clipboard operation
nbformat copied to clipboard

docs for metadata need updating

Open mpacer opened this issue 9 years ago • 10 comments

I'll get to this within the week.

mpacer avatar Sep 14 '16 01:09 mpacer

Specifically, they don't currently mention language_info

takluyver avatar Sep 14 '16 10:09 takluyver

(there may well be other problems too, but that's one omission I've noticed)

takluyver avatar Sep 14 '16 10:09 takluyver

Docs list a "deletable" field, but this isn't implemented.

jjaraalm avatar Dec 21 '16 22:12 jjaraalm

I see code in the notebook UI that checks deletable. There's nothing to implement for it in nbformat.

takluyver avatar Dec 21 '16 23:12 takluyver

But surely it should be in the schema JSON right ? Maybe I'm just misunderstanding the purpose of this repo.

jjaraalm avatar Dec 21 '16 23:12 jjaraalm

I don't think the schema includes keys in metadata, because the ones we use don't have to be there, and arbitrary ones we don't use are allowed there. It's essentially a free key-value store, but the docs describe a few fields that Jupyter applications use.

takluyver avatar Dec 21 '16 23:12 takluyver

@takluyver kinda makes sense to me, but also seems to contradict what is in the schema since some metadata fields are included. For instance, for code cells "scrolled" and "collapsed" are included. I guess if these are mandatory fields, I can understand the logic, but I don't think that's the case; I have valid notebooks generated by Jupyter which do not have the "scrolled" field.

jjaraalm avatar Dec 22 '16 00:12 jjaraalm

Also, docs list it as "autoscroll" whereas schema and Jupyter use "scrolled"

jjaraalm avatar Dec 22 '16 00:12 jjaraalm

Oh, you're right. Thanks! I don't look at the schemas very often...

takluyver avatar Dec 22 '16 10:12 takluyver

How's this now?

rgbkrk avatar Jan 06 '20 21:01 rgbkrk