summaryrefslogtreecommitdiffstats
path: root/doxygen/dox/ReferenceManual.dox
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2023-06-05 23:22:10 (GMT)
committerGitHub <noreply@github.com>2023-06-05 23:22:10 (GMT)
commitcd18732c2ee6e06384d5dfb033f9a9dc1c60ab0d (patch)
tree62b93d13cd3fcd8e60a9b9ad736dde00894a1522 /doxygen/dox/ReferenceManual.dox
parent6787a5bbef0e69aacadc9182f773ffc8a6d12127 (diff)
downloadhdf5-cd18732c2ee6e06384d5dfb033f9a9dc1c60ab0d.zip
hdf5-cd18732c2ee6e06384d5dfb033f9a9dc1c60ab0d.tar.gz
hdf5-cd18732c2ee6e06384d5dfb033f9a9dc1c60ab0d.tar.bz2
Remove most unused options which are defaulted #2998 (#3046)
* Remove most unused options which are defaulted #2998 * Correct doxygen predefined list * Correct doxygen list of predefineds
Diffstat (limited to 'doxygen/dox/ReferenceManual.dox')
-rw-r--r--doxygen/dox/ReferenceManual.dox2
1 files changed, 1 insertions, 1 deletions
diff --git a/doxygen/dox/ReferenceManual.dox b/doxygen/dox/ReferenceManual.dox
index b9bcd49..40f8b8a 100644
--- a/doxygen/dox/ReferenceManual.dox
+++ b/doxygen/dox/ReferenceManual.dox
@@ -158,7 +158,7 @@ Follow these simple rules and stay out of trouble:
\li \Bold{Dynamic memory allocation:} The API contains a few functions in which the
HDF5 library dynamically allocates memory on the caller's behalf. The caller owns
this memory and eventually must free it by calling H5free_memory() and not language-explicit memory functions.
-\li \Bold{Be careful with that saw:} Do not modify the underlying collection when an
+\li \Bold{Don't modify while iterating:} Do not modify the underlying collection when an
iteration is in progress!
\li \Bold{Use of locations:} Certain API functions, typically called \Code{H5***_by_name}
use a combination of identifiers and path names to refer to HDF5 objects.