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

docs for metadata need updating #47

Open
mpacer opened this issue Sep 14, 2016 · 10 comments
Open

docs for metadata need updating #47

mpacer opened this issue Sep 14, 2016 · 10 comments

Comments

@mpacer
Copy link
Member

mpacer commented Sep 14, 2016

I'll get to this within the week.

@takluyver
Copy link
Member

Specifically, they don't currently mention language_info

@takluyver
Copy link
Member

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

@jjaraalm
Copy link

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

@takluyver
Copy link
Member

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

@jjaraalm
Copy link

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

@takluyver
Copy link
Member

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.

@jjaraalm
Copy link

@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
Copy link

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

@takluyver
Copy link
Member

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

saulshanabrook added a commit to saulshanabrook/nbformat that referenced this issue May 23, 2018
This addresses jupyter#47 by documenting the `scrolled` key instead
of the `autoscroll` key. Jupyter Notebook doesn't use the autoscroll key and jupyterlab doesn't either.
@rgbkrk
Copy link
Member

rgbkrk commented Jan 6, 2020

How's this now?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants