documentation update

markvanderloo · Jun 8, 2018 · a7c71e0 · a7c71e0
1 parent c6823bb
commit a7c71e0
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/pkg/inst/include/stringdist_api.h b/pkg/inst/include/stringdist_api.h
@@ -62,6 +62,11 @@ extern "C" {
  * non-UTF-8 encoded strings is untested and is highly likely to result in
  * errors.
  *
+ * @section threads Thread safety
+ *
+ * It is not safe to call functions from `stringdist` C API from 
+ * multiple concurrent threads.
+ *
  *
  *
  */