Fix small documentation issues after 0.15 release (#1440)

* Fix headers in workflow.rst * Fix documentation for preferred_flush_target in ADIOS2
openPMD · Jun 17, 2023 · e533776 · e533776
1 parent d0a0e1d
commit e533776
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/docs/source/backends/adios2.rst b/docs/source/backends/adios2.rst
@@ -238,7 +238,7 @@ In the openPMD-api, this can be done by specifying backend-specific parameters t
 
 .. code:: cpp
 
-  series.flush(R"({"adios2": {"preferred_flush_target": "disk"}})")
+  series.flush(R"({"adios2": {"engine": {"preferred_flush_target": "disk"}}})")
 
 The memory consumption of this approach shows that the 2GB buffer is first drained and then recreated after each ``flush()``:
 
@@ -259,7 +259,7 @@ Note that this involves data copies that can be avoided by either flushing direc
 
 .. code:: cpp
 
-  series.flush(R"({"adios2": {"preferred_flush_target": "buffer"}})")
+  series.flush(R"({"adios2": {"engine": {"preferred_flush_target": "buffer"}}})")
 
 With this strategy, the BP5 engine will slowly build up its buffer until ending the step.
 Rather than by reallocation as in BP4, this is done by appending a new chunk, leading to a clearly more acceptable memory profile:

diff --git a/docs/source/usage/workflow.rst b/docs/source/usage/workflow.rst
@@ -1,7 +1,10 @@
 .. _workflow:
 
+Workflow
+========
+
 Access modes
-============
+------------
 
 The openPMD-api distinguishes between a number of different access modes:
 
@@ -60,9 +63,6 @@ The openPMD-api distinguishes between a number of different access modes:
   It is a user's responsibility to ensure that the appended dataset and the appended-to dataset are compatible with each other.
   The results of using incompatible backend configurations are undefined.
 
-Workflow
-========
-
 Deferred Data API Contract
 --------------------------