Skip to content

Commit

Permalink
Merge pull request #67 from minrk/nbformat-42-notes
Browse files Browse the repository at this point in the history
add notes for 4.2
  • Loading branch information
rgbkrk committed Nov 22, 2016
2 parents 1ab21fa + f9236f7 commit 39164bc
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 2 deletions.
17 changes: 17 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,26 @@
Changes in nbformat
=========================

4.2
===


4.2.0
-----

`4.2 on GitHub <https://github.com/jupyter/nbformat/milestones/4.2>`__

- Update nbformat spec version to 4.2, allowing JSON outputs to have any JSONable type, not just ``object``,
and mime-types of the form ``application/anything+json``.
- Define basics of ``authors`` in notebook metadata.
``nb.metadata.authors`` shall be a list of objects with the property ``name``, a string of each author's full name.
- Update use of traitlets API to require traitlets 4.1.


4.1
===


4.1.0
-----

Expand Down
19 changes: 17 additions & 2 deletions docs/format_description.rst
Original file line number Diff line number Diff line change
Expand Up @@ -312,10 +312,10 @@ keyed by filename that represents the files attached to the cell.
{
"cell_type" : "markdown",
"metadata" : {},
"source" : ["Here is an *inline* image ![inline image](attachment:test.png)"],
"source" : ["Here is an *inline* image ![inline image](attachment://test.png)"],
"attachments" : {
"test.png": {
"image/png" : ["base64-encoded-png-data"]
"image/png" : "base64-encoded-png-data"
}
}
}
Expand Down Expand Up @@ -356,8 +356,23 @@ The following metadata keys are defined at the notebook level:
Key Value Interpretation
=========== =============== ==============
kernelspec dict A :ref:`kernel specification <kernelspecs>`
authors list of dicts A list of authors of the document
=========== =============== ==============

A notebook's authors is a list of dictionaries containing information about each author of the notebook.
Currently, only the name is required.
Additional fields may be added.

.. sourcecode:: python

nb.metadata.authors = [
{
'name': 'Fernando Perez',
},
{
'name': 'Brian Granger',
},
]

Cell metadata
-------------
Expand Down

0 comments on commit 39164bc

Please sign in to comment.