First Read/Write: Flush Type

Author: ax3l

docs/source/usage/firstread.rst

@@ -89,6 +89,9 @@ C++11
        "data%T.h5",
        api::AccessType::READ_ONLY);
 
+   // optional: accumulate heavy load
+   //    operations until .flush()
+   // series.setFlush(api::FlushType::DEFER);
 
 Python
 ^^^^^^
@@ -99,6 +102,10 @@ Python
        "data%T.h5",
        api.Access_Type.read_only)
 
+   # optional: accumulate heavy load
+   #   operations until .flush()
+   # series.set_flush(api.Flush_Type.defer)
+
 Iteration
 ---------
 
@@ -268,6 +275,11 @@ Python
 
    series.flush()
 
+.. note::
+
+   You can *skip this step* if your series flush mode is *not* ``FlushType::DEFER``/``Flush_Type.defer``.
+   With the convenient default (``FlushType::DIRECT``/``Flush_Type.direct``), we call ``flush()`` implicitly in ``load_chunk()``.
+
 Data
 -----
 

docs/source/usage/firstwrite.rst

@@ -87,6 +87,9 @@ C++11
        "myOutput/data_%05T.h5",
        api::AccessType::CREATE);
 
+   // optional: accumulate heavy store
+   //    operations until .flush()
+   // series.setFlush(api::FlushType::DEFER);
 
 Python
 ^^^^^^
@@ -97,6 +100,10 @@ Python
        "myOutput/data_%05T.h5",
        api.Access_Type.create)
 
+   # optional: accumulate heavy store
+   #   operations until .flush()
+   # series.set_flush(api.Flush_Type.defer)
+
 Iteration
 ---------
 
@@ -340,6 +347,11 @@ Python
 
    series.flush()
 
+.. note::
+
+   You can *skip this step* if your series flush mode is *not* ``FlushType::DEFER``/``Flush_Type.defer``.
+   With the convenient default (``FlushType::DIRECT``/``Flush_Type.direct``), we call ``flush()`` implicitly in ``store_chunk()``.
+
 Close
 -----