fix some typos in UCX 2.1 documentation

Tue, 20 Jun 2023 19:13:31 +0200

author
Mike Becker <universe@uap-core.de>
date
Tue, 20 Jun 2023 19:13:31 +0200
changeset 717
aa17be68fc66
parent 716
bab81cf591a5
child 718
cf2f209b9da2

fix some typos in UCX 2.1 documentation

docs/src/modules-ucx2.md file | annotate | diff | comparison | revisions
--- a/docs/src/modules-ucx2.md	Tue Jun 20 19:04:07 2023 +0200
+++ b/docs/src/modules-ucx2.md	Tue Jun 20 19:13:31 2023 +0200
@@ -3,12 +3,12 @@
 ---
 
 UCX 2.1 provided several modules for data structures and algorithms.
-You may choose to use specific modules by inclueding the corresponding header
+You may choose to use specific modules by including the corresponding header
 file.
 Please note, that some modules make use of other UCX 2.1 modules.
 For instance, the [Allocator](#allocator) module is used by many other modules
 to allow flexible memory allocation.
-By default the header files are placed into an `ucx` directory within your
+By default, the header files are placed into an `ucx` directory within your
 systems include directory. In this case you can use a module by including it
 via `#include <ucx/MODULENAME.h>`.
 Required modules are included automatically.
@@ -522,9 +522,9 @@
 ```
 Be aware, that your destructor function should not free any memory, that is
 also managed by the pool.
-Otherwise you might be risking a double-free.
+Otherwise, you might be risking a double-free.
 More precisely, a destructor function set with `ucx_mempool_set_destr()` MUST
-NOT call `free()` on the specified pointer whereas a desructor function
+NOT call `free()` on the specified pointer whereas a destructor function
 registered with `ucx_mempool_reg_destr()` MAY (and in most cases will) call
 `free()`.
 
@@ -681,7 +681,7 @@
 the first occurrence of the specified character.
 Since this substring points to the memory of the argument string, it does not
 accept `scstr_t` as input argument, because the return type would break the
-constness.
+const-ness.
 
 
 ### Finding the position of a substring
@@ -785,7 +785,7 @@
 ```
 If you want to use the `UCX_TEST_ASSERT()` macro in a function, you are
 *required* to use a `UCX_TEST_SUBROUTINE`.
-Otherwise the testing framework does not know where to jump, when the assertion
+Otherwise, the testing framework does not know where to jump, when the assertion
 fails.
 
 After implementing the tests, you can easily build a test suite and execute it:

mercurial