From 1f2336394b3fa14a587e45daaed8d37f6e48a57b Mon Sep 17 00:00:00 2001 From: Michael Ilyin Date: Mon, 14 Oct 2024 11:33:34 +0200 Subject: [PATCH] prefix doc update --- docs/concepts.rst | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/concepts.rst b/docs/concepts.rst index a217e7b69..239beb1d5 100644 --- a/docs/concepts.rst +++ b/docs/concepts.rst @@ -149,10 +149,15 @@ Types named `z_xxx_t` are copyable, and can be passed by value. Some of them are Name Prefixes `z_`, `zc_`, `ze_` ================================ -Most functions and types in the C API use the `z_` prefix, which applies to the common zenoh C API -(currently Rust-based zenoh-c and pure C zenoh-pico). - -The `zc_` prefix is specific to zenoh-c. zenoh-pico uses the `zp_` prefix for the same purpose. - -The `ze_` prefix identifies functions and types from the `zenoh-ext` Rust library that are not -part of the core Zenoh API and therefore are placed in a separate namespace. \ No newline at end of file +Most functions and types in the C API use the `z_` prefix, which applies to the core Zenoh API. +These functions and types are guaranteed to be available in all Zenoh implementations on C +(currently, Rust-based zenoh-c and pure C zenoh-pico). + +The `ze_` prefix is used for the API that is not part of the core zenoh API. There is no guarantee that +these functions and types are available everywhere. However, when they are provided, they should +have the same prototype and behavior across all implementations. Typically, these are functions and types +provided by the `zenoh-ext` Rust library for zenoh-c and are not available in zenoh-pico. However, the data +serialization API is implemented in zenoh-pico with the same `ze_` prefix. + +The `zc_` prefix is specific to zenoh-c, while zenoh-pico uses the `zp_` prefix for the same purpose. Usually, +these functions are specific to a particular implementation. \ No newline at end of file