Skip to content

Commit

Permalink
fix string-related function names in docs (#496)
Browse files Browse the repository at this point in the history
* updated docs after pr #495

* updated docs
  • Loading branch information
DenisBiryukov91 authored Jul 4, 2024
1 parent 735e2e1 commit e4e99b4
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 32 deletions.
50 changes: 25 additions & 25 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,23 +57,23 @@ Types

Functions
^^^^^^^^^
.. doxygenfunction:: z_str_check
.. doxygenfunction:: z_string_check
.. doxygenfunction:: z_view_str_check
.. doxygenfunction:: z_str_null
.. doxygenfunction:: z_string_null
.. doxygenfunction:: z_view_str_null
.. doxygenfunction:: z_str_loan
.. doxygenfunction:: z_string_loan
.. doxygenfunction:: z_view_str_loan
.. doxygenfunction:: z_str_drop
.. doxygenfunction:: z_string_drop

.. doxygenfunction:: z_str_empty
.. doxygenfunction:: z_string_empty
.. doxygenfunction:: z_view_str_empty

.. doxygenfunction:: z_str_wrap
.. doxygenfunction:: z_string_wrap
.. doxygenfunction:: z_view_str_wrap
.. doxygenfunction:: z_str_from_substring
.. doxygenfunction:: z_str_data
.. doxygenfunction:: z_str_len
.. doxygenfunction:: z_str_is_empty
.. doxygenfunction:: z_string_from_substr
.. doxygenfunction:: z_string_data
.. doxygenfunction:: z_string_len
.. doxygenfunction:: z_string_is_empty

Slice map
---------
Expand Down Expand Up @@ -107,16 +107,16 @@ Types

Functions
^^^^^^^^^
.. doxygenfunction:: z_str_array_check
.. doxygenfunction:: z_str_array_null
.. doxygenfunction:: z_str_array_drop
.. doxygenfunction:: z_str_array_loan
.. doxygenfunction:: z_str_array_loan_mut
.. doxygenfunction:: z_string_array_check
.. doxygenfunction:: z_string_array_null
.. doxygenfunction:: z_string_array_drop
.. doxygenfunction:: z_string_array_loan
.. doxygenfunction:: z_string_array_loan_mut

.. doxygenfunction:: z_str_array_new
.. doxygenfunction:: z_str_array_get
.. doxygenfunction:: z_str_array_len
.. doxygenfunction:: z_str_array_is_empty
.. doxygenfunction:: z_string_array_new
.. doxygenfunction:: z_string_array_get
.. doxygenfunction:: z_string_array_len
.. doxygenfunction:: z_string_array_is_empty

Common
======
Expand Down Expand Up @@ -210,11 +210,11 @@ Functions
.. doxygenfunction:: z_view_keyexpr_from_string_autocanonize
.. doxygenfunction:: z_view_keyexpr_from_string_unchecked

.. doxygenfunction:: z_keyexpr_from_substring
.. doxygenfunction:: z_view_keyexpr_from_substring
.. doxygenfunction:: z_keyexpr_from_substring_autocanonize
.. doxygenfunction:: z_view_keyexpr_from_substring_autocanonize
.. doxygenfunction:: z_view_keyexpr_from_substring_unchecked
.. doxygenfunction:: z_keyexpr_from_substr
.. doxygenfunction:: z_view_keyexpr_from_substr
.. doxygenfunction:: z_keyexpr_from_substr_autocanonize
.. doxygenfunction:: z_view_keyexpr_from_substr_autocanonize
.. doxygenfunction:: z_view_keyexpr_from_substr_unchecked

.. doxygenfunction:: z_keyexpr_loan
.. doxygenfunction:: z_view_keyexpr_loan
Expand Down Expand Up @@ -253,7 +253,7 @@ Functions

.. doxygenfunction:: z_encoding_loan_default
.. doxygenfunction:: z_encoding_from_str
.. doxygenfunction:: z_encoding_from_substring
.. doxygenfunction:: z_encoding_from_substr
.. doxygenfunction:: z_encoding_to_string

Value
Expand Down
14 changes: 7 additions & 7 deletions docs/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ Subscribe
z_owned_string_t payload_string;
z_bytes_deserialize_into_string(z_sample_payload(sample), &payload_string);
printf(">> Received (%.*s, %.*s)\n",
(int)z_str_len(z_loan(key_string)), z_str_data(z_loan(key_string)),
(int)z_str_len(z_loan(payload_string)), z_str_data(z_loan(payload_string))
(int)z_string_len(z_loan(key_string)), z_string_data(z_loan(key_string)),
(int)z_string_len(z_loan(payload_string)), z_string_data(z_loan(payload_string))
);
z_drop(z_move(payload_string));
Expand Down Expand Up @@ -131,8 +131,8 @@ Query
z_owned_string_t payload_string;
z_bytes_deserialize_into_string(z_sample_payload(sample), &payload_string);
printf(">> Received (%.*s, %.*s)\n",
(int)z_str_len(z_loan(key_string)), z_str_data(z_loan(key_string)),
(int)z_str_len(z_loan(payload_string)), z_str_data(z_loan(payload_string))
(int)z_string_len(z_loan(key_string)), z_string_data(z_loan(key_string)),
(int)z_string_len(z_loan(payload_string)), z_string_data(z_loan(payload_string))
);
z_drop(z_move(payload_string));
}
Expand Down Expand Up @@ -163,11 +163,11 @@ Queryable
z_bytes_deserialize_into_string(payload, &payload_string);
printf(">> [Queryable ] Received Query '%.*s' with value '%.*s'\n",
(int)z_str_len(z_loan(key_string)), z_str_data(z_loan(key_string)),
(int)z_str_len(z_loan(payload_string)), z_str_data(z_loan(payload_string)));
(int)z_string_len(z_loan(key_string)), z_string_data(z_loan(key_string)),
(int)z_string_len(z_loan(payload_string)), z_string_data(z_loan(payload_string)));
z_drop(z_move(payload_string));
} else {
printf(">> [Queryable ] Received Query '%s'\n", z_str_data(z_loan(key_string)));
printf(">> [Queryable ] Received Query '%s'\n", z_string_data(z_loan(key_string)));
}
z_owned_bytes_t reply_payload;
Expand Down

0 comments on commit e4e99b4

Please sign in to comment.