search

eclipse-zenoh / zenoh-c

C API for Zenoh
http://zenoh.io
Other
80 stars 57 forks source link

rename `z_declare_xxx` functions #748

Closed milyin closed 1 month ago

milyin commented 1 month ago

Describe the release item

All functions in zenoh-c api are named like z_object_action. E.h. z_subscriber_drop, z_keyexpr_join, etc. The exceptions are z_declare_subscriber, z_undeclare_subscriber and others as their names came directly from Rust API. To make API consistent and predictable it's better to rename them to follow the same logic as other C functions: z_subscriber_declare, etc

kydos commented 1 month ago

What is the impact on users? I believe we have a z_drop macro right? But everyone is using z_declare_subscriber. Thus is any change is done could be moving to z_drop_subscriber as opposed to changing z_declare_subscriber`.

Additionally, I am not keen to changez_open, z_close, z_get, etc. As far as we consistently leave the session out, we could imply assume and clearly document that this is the convention -- nothing means session.

Bottomline we should minimise the pain for users in porting to v1.0.0. Consistency is great, but if we can have consistency and avoid changes that's even better. Thus I'd favor changing names on anything that is usually used via a macro.