Jun 5, 2020 · Jun 4, 2020 · Jun 5, 2020 · Jun 5, 2020
diff --git a/docs/source/extending/contents.rst b/docs/source/extending/contents.rst
 ``FileCheckpoints``, could be incompatible with your custom
 ContentsManager.


 Chunked Saving
 ~~~~~~~~~~~~~~

 The contents API allows for "chunked" saving of files, i.e.
 saving/transmitting in partial pieces:

 * This can only be used when the ``type`` of the model is ``file``.
 * The model should be as otherwise expected for
  :meth:`~manager.ContentsManager.save`, with an added field ``chunk``.
 * The value of ``chunk`` should be an integer starting at ``1``, and incrementing
  for each subsequent chunk, except for the final chunk, which should be
  indicated with a value of ``-1``.
 * The model returned from using :meth:`~manager.ContentsManager.save` with
  ``chunk`` should be treated as unreliable for all chunks except the final one.
 * Any interaction with a file being saved in a chunked manner is unreliable
  until the final chunk has been saved. This includes directory listings.


 Customizing Checkpoints
 -----------------------
 .. currentmodule:: notebook.services.contents.checkpoints
diff --git a/setup.py b/setup.py
        'test': ['nose', 'coverage', 'requests', 'nose_warnings_filters',
                 'nbval', 'nose-exclude', 'selenium', 'pytest', 'pytest-cov',
                 'requests-unixsocket'],
        'docs': ['sphinx', 'nbsphinx', 'sphinxcontrib_github_alt'],
        'test:sys_platform == "win32"': ['nose-exclude'],
    },
    python_requires = '>=3.5',
Original file line number	Diff line number	Diff line change
Expand Up		@@ -200,6 +200,25 @@ You may be required to specify a Checkpoints object, as the default one,
		``FileCheckpoints``, could be incompatible with your custom
		ContentsManager.


		Chunked Saving
		~~~~~~~~~~~~~~

		The contents API allows for "chunked" saving of files, i.e.
		saving/transmitting in partial pieces:

		* This can only be used when the ``type`` of the model is ``file``.
		* The model should be as otherwise expected for
		:meth:`~manager.ContentsManager.save`, with an added field ``chunk``.
		* The value of ``chunk`` should be an integer starting at ``1``, and incrementing
		for each subsequent chunk, except for the final chunk, which should be
		indicated with a value of ``-1``.
		* The model returned from using :meth:`~manager.ContentsManager.save` with
		``chunk`` should be treated as unreliable for all chunks except the final one.
		* Any interaction with a file being saved in a chunked manner is unreliable
		until the final chunk has been saved. This includes directory listings.
vidartf marked this conversation as resolved. Show resolvedHide resolved


		Customizing Checkpoints
		-----------------------
		.. currentmodule:: notebook.services.contents.checkpoints
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -117,6 +117,7 @@
		'test': ['nose', 'coverage', 'requests', 'nose_warnings_filters',
		'nbval', 'nose-exclude', 'selenium', 'pytest', 'pytest-cov',
		'requests-unixsocket'],
		'docs': ['sphinx', 'nbsphinx', 'sphinxcontrib_github_alt'],
		'test:sys_platform == "win32"': ['nose-exclude'],
		},
		python_requires = '>=3.5',
Expand Down