Add note about strings to the file layer docs

glotzerlab · Sep 16, 2024 · 21a63ef · 21a63ef
1 parent 45c0e96
commit 21a63ef
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/doc/file-layer.rst b/doc/file-layer.rst
@@ -235,3 +235,6 @@ Data block
 A data block stores raw data bytes on the disk. For a given index entry
 ``entry``, the data starts at location ``entry.location`` and is the next
 ``entry.N * entry.M * gsd_sizeof_type(entry.type)`` bytes.
+
+The type fields are self-explanatory except for UTF-8 strings, for which
+null-termination is allowed but not required.