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

Added missing cell execution docs for new schema #159

Merged
merged 2 commits into from
Jan 8, 2020

Conversation

MSeal
Copy link
Contributor

@MSeal MSeal commented Jan 6, 2020

A user noticed this wasn't updated in the read-the-docs. Doesn't need a release but will explain the schema changes and how to interpret them.

@meeseeksmachine
Copy link

This pull request has been mentioned on Jupyter Community Forum. There might be relevant details there:

https://discourse.jupyter.org/t/nbformat-5-0-1-release/3001/3

Copy link
Member

@akhmerov akhmerov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

execution probably also needs to be added to this table

@MSeal
Copy link
Contributor Author

MSeal commented Jan 7, 2020

execution probably also needs to be added to this table

Which table are you referring to? I copied the pattern for the jupyter namespace docs above where the namespace is referenced in the description but not in the table. I could add a column with namespace so it's clearer when reading the tables?

@akhmerov
Copy link
Member

akhmerov commented Jan 7, 2020

Sorry, I expected the above comment would show as a line comment, but something didn't work. I mean this:

image

@MSeal
Copy link
Contributor Author

MSeal commented Jan 7, 2020

I could add it there -- the table also doesn't have jupyter namespace specified either so I was being consistent to the docs as-is. It probably makes sense to add both jupyter and execution to that table.

@akhmerov
Copy link
Member

akhmerov commented Jan 7, 2020

Ah, so is it metadata.jupyter.execution, and not metadata.execution? I thought the latter...

@MSeal
Copy link
Contributor Author

MSeal commented Jan 7, 2020

No it's metadata.execution. I was referencing that jupyter isn't in that table either and has the same pattern of nested values as execution. It has a dedicated section in the doc so I copied that pattern for the new namespace field. I'll just update the doc to make it clearer and see if it matches expectations.

@MSeal MSeal merged commit 7cfe0f5 into jupyter:master Jan 8, 2020
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

Successfully merging this pull request may close these issues.

3 participants