zenoh
zenoh copied to clipboard
deafult parameter values not documented
There are builder methods which sets various parameters of Publisher
. Queryable
, etc.
For example:
let publisher = session
.declare_publisher("key/expression")
.congestion_control(CongestionControl::Block)
.priority(Priority::Data)
.res()
Calling these methods is optional. It's unclear which are the default values for these parameters. The only way to know is to look into the source of Session::declare_publisher
: https://docs.rs/zenoh/0.10.1-rc/src/zenoh/session.rs.html#614-629
This is wrong. The default values of Publisher
options is part of Publisher's API and should be explicitly specified for it. Same thing for all other entities.
Default variants of enums
(e.g. CongestionControl) are somehow not propagated in the docs.
An associated const DEFAULT
is being added to all those types in https://github.com/eclipse-zenoh/zenoh/pull/729/files. By doing so, it will be clear what's the default value for all those parameters. Would that suffice?
Default variants of
enums
(e.g. CongestionControl) are somehow not propagated in the docs.An associated
const DEFAULT
is being added to all those types in https://github.com/eclipse-zenoh/zenoh/pull/729/files. By doing so, it will be clear what's the default value for all those parameters. Would that suffice?
Yes, I think this solves the problem
Fixed in https://github.com/eclipse-zenoh/zenoh/pull/729/files