From 3149249151876106bdc69667c7a8e1dd77e44f99 Mon Sep 17 00:00:00 2001 From: Greg Eisenhauer Date: Fri, 26 Apr 2024 14:45:43 -0400 Subject: [PATCH] Minor docs tweaks --- docs/user_guide/source/components/io.rst | 2 +- docs/user_guide/source/tutorials/helloWorld.rst | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/user_guide/source/components/io.rst b/docs/user_guide/source/components/io.rst index 326b93ad34..4e6906bc6d 100644 --- a/docs/user_guide/source/components/io.rst +++ b/docs/user_guide/source/components/io.rst @@ -196,7 +196,7 @@ A particular ``Engine`` type is set to the current ``IO`` component with the ``I Engine polymorphism is handled internally by the ``IO`` class, which allows subclassing future derived ``Engine`` types without changing the basic API. ``Engine`` objects are created in various modes. -The available modes are ``adios2::Mode::Read``, ``adios2::Mode::Write``, ``adios2::Mode::Append``, ``adios2::Mode::Sync``, ``adios2::Mode::Deferred``, and ``adios2::Mode::Undefined``. +The available modes are ``adios2::Mode::Read``, ``adios2::Mode::ReadRandomAccess``, ``adios2::Mode::ReadFlattenSteps``, ``adios2::Mode::Write``, ``adios2::Mode::Append``, ``adios2::Mode::Sync``, ``adios2::Mode::Deferred``, and ``adios2::Mode::Undefined``. .. code-block:: c++ diff --git a/docs/user_guide/source/tutorials/helloWorld.rst b/docs/user_guide/source/tutorials/helloWorld.rst index a0e424a097..cdc709eea0 100644 --- a/docs/user_guide/source/tutorials/helloWorld.rst +++ b/docs/user_guide/source/tutorials/helloWorld.rst @@ -86,6 +86,7 @@ Start editing the skeleton file `ADIOS2/examples/hello/helloWorld/hello-world_tu adios2::Engine reader = io.Open("hello-world-cpp.bp", adios2::Mode::Read); std::string greeting; + reader.BeginStep(); reader.Get(varGreeting, greeting); reader.EndStep(); reader.Close(); @@ -93,7 +94,7 @@ Start editing the skeleton file `ADIOS2/examples/hello/helloWorld/hello-world_tu .. note:: - The ``BeginStep`` and ``EndStep`` calls are required when **reading** one step and multiple steps. We will see in + In Mode::Read, the ``BeginStep`` and ``EndStep`` calls are required when **reading** one step and multiple steps. We will see in another tutorial how to read multiple steps. It's important to note that the ``BeginStep`` should be called **before** all ``Inquire*`` / ``Available*`` function calls.