Skip to content

Commit 078f5c7

Browse files
committed
Document extended meaning of createFile task
1 parent 79062c2 commit 078f5c7

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

include/openPMD/IO/AbstractIOHandlerImpl.hpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,10 @@ class AbstractIOHandlerImpl
187187
/** Create a new file in physical storage, possibly overriding an existing file.
188188
*
189189
* The operation should fail if m_handler->m_frontendAccess is Access::READ_ONLY.
190+
* If m_handler->m_frontendAccess is Access::APPEND, a possibly existing file should not
191+
* be overwritten.
192+
* Instead, written updates should then either occur in-place or in form of new IO steps.
193+
* Support for reading is not necessary in Append mode.
190194
* The new file should be located in m_handler->directory.
191195
* The new file should have the filename parameters.name.
192196
* The filename should include the correct corresponding filename extension.

0 commit comments

Comments
 (0)