docs: retention period values in Namespace client
Document the 0/null and negative value behaviours for retention periods
in the namespace RPC client.
@@ -33,8 +33,11 @@ impl Client {
/// Create a namespace
///
- /// `retention_period_ns` is the the retention period in nanoseconds, measured from `now()`.
- /// `None` represents infinite retention (i.e. never drop data).
+ /// `retention_period_ns` is the the retention period in nanoseconds,
+ /// measured from `now()`. `None` represents infinite retention (i.e. never
+ /// drop data), and 0 is also mapped to `None` on the server side.
+ ///
+ /// Negative retention periods are rejected, returning an error.
pub async fn create_namespace(
&mut self,
namespace: &str,
@@ -53,8 +56,11 @@ impl Client {
/// Update retention for a namespace
///
- /// `retention_period_ns` is the the retention period in nanoseconds, measured from `now()`.
- /// `None` represents infinite retention (i.e. never drop data).
+ /// `retention_period_ns` is the the retention period in nanoseconds,
+ /// measured from `now()`. `None` represents infinite retention (i.e. never
+ /// drop data), and 0 is also mapped to `None` on the server side.
+ ///
+ /// Negative retention periods are rejected, returning an error.
pub async fn update_namespace_retention(
&mut self,
namespace: &str,
