Merge pull request #2521 from ornladios/NAThompson-patch-2

Calling close() is not optional
ornladios · Dec 24, 2020 · 8a850ec · 8a850ec
2 parents 7854b5f + e8421a0
commit 8a850ec
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/docs/user_guide/source/api_high/cxx11.rst b/docs/user_guide/source/api_high/cxx11.rst
@@ -46,7 +46,7 @@ C++11 Write example
 
    }
 
-   // optional, but is good practice to indicate oStream shouldn't be used 
+   // Calling close is mandatory!
    oStream.close(); 
 
 C++11 Read "step-by-step" example
@@ -81,7 +81,7 @@ C++11 Read "step-by-step" example
           const std::vector<float> temperature = iStream.read<float>( "temperature", start, count );
           const std::vector<float> pressure = iStream.read<float>( "pressure", start, count );
       }
-      // optional, but is good practice to indicate iStream shouldn't be used 
+      // Don't forget to call close!
       iStream.close(); 
    }