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

API alignment #731

Merged
merged 5 commits into from
Oct 10, 2024
Merged

API alignment #731

merged 5 commits into from
Oct 10, 2024

Conversation

sashacmc
Copy link
Member

@sashacmc sashacmc commented Oct 10, 2024

  • Rename z_publisher_declare to z_declare_publisher and make session first
  • Rename z_subscriber_declare to z_declare_subscriber and make session first
  • Rename z_queryable_declare to z_declare_queryable and make session first
  • Move a session as the first parameter for z_declare_keyexpr/z_undeclare_keyexpr
  • Return undeclare method for publisher/subscriber/queryable

Copy link

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

@sashacmc sashacmc added api sync Synchronize API with other bindings enhancement Things could work better labels Oct 10, 2024
@sashacmc sashacmc marked this pull request as ready for review October 10, 2024 16:00
@sashacmc sashacmc added internal Changes not included in the changelog and removed enhancement Things could work better labels Oct 10, 2024
@@ -1899,7 +1921,7 @@ z_result_t z_keyexpr_from_substr_autocanonize(z_owned_keyexpr_t *keyexpr, const
* Return:
* ``0`` if declare is successful, ``negative value`` otherwise.
*/
z_result_t z_declare_keyexpr(z_owned_keyexpr_t *declared_keyexpr, const z_loaned_session_t *zs,
z_result_t z_declare_keyexpr(const z_loaned_session_t *zs, z_owned_keyexpr_t *declared_keyexpr,
Copy link
Contributor

Choose a reason for hiding this comment

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

need to update order of arguments in the docs

@@ -1912,7 +1934,7 @@ z_result_t z_declare_keyexpr(z_owned_keyexpr_t *declared_keyexpr, const z_loaned
* Return:
* ``0`` if undeclare is successful, ``negative value`` otherwise.
*/
z_result_t z_undeclare_keyexpr(z_moved_keyexpr_t *keyexpr, const z_loaned_session_t *zs);
z_result_t z_undeclare_keyexpr(const z_loaned_session_t *zs, z_moved_keyexpr_t *keyexpr);
Copy link
Contributor

Choose a reason for hiding this comment

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

need to update order of arguments in the docs

@milyin milyin merged commit 9bf1203 into eclipse-zenoh:main Oct 10, 2024
54 of 55 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api sync Synchronize API with other bindings internal Changes not included in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants