Skip to content

Commit ca60bcf

Browse files
Mariko WakabayashiZsailer
authored andcommitted
Add asynchronous support section
1 parent 1cfc211 commit ca60bcf

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

docs/source/developers/contents.rst

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -192,19 +192,19 @@ methods:
192192
ContentsManager.is_hidden
193193

194194
You may be required to specify a Checkpoints object, as the default one,
195-
``FileCheckpoints``, could be incompatible with your custom
195+
``FileCheckpoints``, could be incompatible with your custom
196196
ContentsManager.
197197

198198
Customizing Checkpoints
199199
-----------------------
200200
.. currentmodule:: jupyter_server.services.contents.checkpoints
201201

202-
Customized Checkpoint definitions allows behavior to be
202+
Customized Checkpoint definitions allows behavior to be
203203
altered and extended.
204204

205205
The ``Checkpoints`` and ``GenericCheckpointsMixin`` classes
206206
(from :mod:`jupyter_server.services.contents.checkpoints`)
207-
have reusable code and are intended to be used together,
207+
have reusable code and are intended to be used together,
208208
but require the following methods to be implemented.
209209

210210
.. autosummary::
@@ -220,7 +220,7 @@ No-op example
220220
~~~~~~~~~~~~~
221221

222222
Here is an example of a no-op checkpoints object - note the mixin
223-
comes first. The docstrings indicate what each method should do or
223+
comes first. The docstrings indicate what each method should do or
224224
return for a more complete implementation.
225225

226226
.. code-block:: python
@@ -238,7 +238,7 @@ return for a more complete implementation.
238238
def delete_checkpoint(self, checkpoint_id, path):
239239
"""deletes a checkpoint for a file"""
240240
def list_checkpoints(self, path):
241-
"""returns a list of checkpoint models for a given file,
241+
"""returns a list of checkpoint models for a given file,
242242
default just does one per file
243243
"""
244244
return []
@@ -267,3 +267,13 @@ ContentsManager.
267267
.. _NBFormat: https://nbformat.readthedocs.io/en/latest/index.html
268268
.. _PGContents: https://github.com/quantopian/pgcontents
269269
.. _PostgreSQL: https://www.postgresql.org/
270+
271+
Asynchronous Support
272+
~~~~~~~~~~~~~~~~~~~~
273+
274+
To execute file operations asynchronously in a virtual filesystem, the following classes are available.
275+
276+
- :class:`~manager.AsyncContentsManager`
277+
- :class:`~filemanager.AsyncFileContentsManager`
278+
- :class:`~checkpoints.AsyncCheckpoints`
279+

0 commit comments

Comments
 (0)