Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add doc warnings for unstable methods #706

Merged
merged 1 commit into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1079,9 +1079,11 @@ See details at :ref:`owned_types_concept`
.. c:function:: const z_loaned_hello_t * z_hello_loan(const z_owned_hello_t * hello)


Serialization (unstable)
Serialization
========================

.. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

Types
-----

Expand Down
2 changes: 2 additions & 0 deletions include/zenoh-pico/api/constants.h
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,8 @@ typedef enum {
* Enumerators:
* Z_RELIABILITY_BEST_EFFORT: Defines reliability as ``BEST_EFFORT``
* Z_RELIABILITY_RELIABLE: Defines reliability as ``RELIABLE``
*
* .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release.
*/
typedef enum { Z_RELIABILITY_BEST_EFFORT = 1, Z_RELIABILITY_RELIABLE = 0 } z_reliability_t;
#define Z_RELIABILITY_DEFAULT Z_RELIABILITY_RELIABLE
Expand Down
4 changes: 4 additions & 0 deletions include/zenoh-pico/api/primitives.h
Original file line number Diff line number Diff line change
Expand Up @@ -1413,6 +1413,8 @@ z_sample_kind_t z_sample_kind(const z_loaned_sample_t *sample);
*
* Return:
* The reliability wrapped as a :c:type:`z_reliability_t`.
*
* .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release.
*/
z_reliability_t z_sample_reliability(const z_loaned_sample_t *sample);
#endif
Expand Down Expand Up @@ -2130,6 +2132,8 @@ z_result_t zp_send_join(const z_loaned_session_t *zs, const zp_send_join_options
*
* Return:
* The reliability wrapped as a :c:type:`z_reliability_t`.
*
* .. warning:: This API has been marked as unstable: it works as advertised, but it may be changed in a future release.
*/
z_reliability_t z_reliability_default(void);
#endif
Expand Down
Loading
Loading