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

Fix c type formatting in documentation #711

Merged
merged 2 commits into from
Oct 7, 2024

Conversation

sashacmc
Copy link
Member

@sashacmc sashacmc commented Oct 4, 2024

:c:types: prefix should be used for cross document links, using this prefix for system types make no sense and produce sphinx warnings.
This PR fix it.

Copy link

github-actions bot commented Oct 4, 2024

PR missing one of the required labels: {'bug', 'documentation', 'dependencies', 'enhancement', 'internal', 'breaking-change', 'new feature'}

@sashacmc sashacmc added bug Something isn't working documentation Improvements or additions to documentation labels Oct 4, 2024
@sashacmc sashacmc marked this pull request as ready for review October 4, 2024 20:31
@@ -606,7 +606,7 @@ z_result_t ze_serialize_str(z_owned_bytes_t *bytes, const char *value);
z_result_t ze_serialize_slice(z_owned_bytes_t *bytes, const z_loaned_slice_t *slice);

/**
* Serializes a :c:type:`int8_t` into a :c:type:`z_owned_bytes_t` .
* Serializes a `int8_t` into a :c:type:`z_owned_bytes_t` .
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

an 'int8_t' (and same for other ints) ?

@milyin milyin merged commit d5f7d3f into eclipse-zenoh:main Oct 7, 2024
53 of 54 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants