From 62d738cbbeca6d85f661d06ec417020788c0db7d Mon Sep 17 00:00:00 2001 From: veclavtalica Date: Fri, 3 Jan 2025 11:49:00 +0300 Subject: [PATCH] /docs/interop.md: update --- docs/interop.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/interop.md b/docs/interop.md index dbf4729..8970fd5 100644 --- a/docs/interop.md +++ b/docs/interop.md @@ -4,13 +4,13 @@ for that certain considerations are taken: * number of public api calls is kept at the minimum * procedure parameters can only use basic types, no aggregates, with exception of Vec/Matrix types and alike, - with no expectation on new additions (see [/include/twn_types.h](../include/twn_types.h)) -* optionals can be expressed via pointer passage of value primitives, assumed immutable, with the NULL expressing default -* no opaque types, only keys + with no new additions, ever (see [/include/twn_types.h](../include/twn_types.h)) +* optionals can be expressed via pointer passage of value primitives, assumed immutable, with the NULL expressing default value +* no opaque types, only keys if needed * pointers to pointers aren't allowed -* when mutation on input is done, - it shouldn't be achieved from a mutable pointer, but the return value -* return value could be a simple aggregate that is translatable to pure data dictionary +* when mutation on input is done, - it shouldn't be achieved by a mutable pointer, but the return value +* return value could be a simple aggregate that is translatable to a dictionary of primitives * module prefix is used for namespacing, actual symbols come after the prefix (`_`) * symbols should not contain numerics at the start nor after the namespace prefix * 32 bit floating point is the only numeric type -* [/include/twn_api.json](../include/twn_api.json) file is hand-kept with a schema to aid automatic binding generation and tooling +* [/include/twn_api.json](../share/twn_api.json) file is hand-kept with a schema to aid automatic binding generation and tooling