From 2249fba51b96b6a3ff72e17ddbb247129a8bd610 Mon Sep 17 00:00:00 2001 From: Vidar Tonaas Fauske Date: Thu, 31 Oct 2019 10:26:06 +0000 Subject: [PATCH] Update contents.rst --- docs/source/extending/contents.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/source/extending/contents.rst b/docs/source/extending/contents.rst index 55032a402..c987216b2 100644 --- a/docs/source/extending/contents.rst +++ b/docs/source/extending/contents.rst @@ -100,9 +100,10 @@ model. There are three model types: **notebook**, **file**, and **directory**. .. _contentfree: In certain circumstances, we don't need the full content of an entity to - complete a Contents API request. In such cases, we omit the ``content``, and - ``format`` keys from the model, and the default values for the ``mimetype`` - field (see above). This most commonly occurs when listing a directory, in + complete a Contents API request. In such cases, we omit the ``content``, and + ``format`` keys from the model. The default values for the ``mimetype`` + field will might also not be evaluated, in which case it will be set as `None`. + This reduced reply most commonly occurs when listing a directory, in which circumstance we represent files within the directory as content-less models to avoid having to recursively traverse and serialize the entire filesystem.