Skip to content

Commit b3fd8d8

Browse files
authored
Fix identation in rustdoc (#1874)
1 parent a9a17ed commit b3fd8d8

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

io/zenoh-transport/src/common/seq_num.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,12 @@ impl SeqNum {
5050
/// * `value` - The sequence number.
5151
///
5252
/// * `resolution` - The resolution (modulo) to be used for the sequence number.
53-
/// As a consequence of wire zenoh's representation of sequence numbers it is
54-
/// recommended that the resolution is a power of 2 with exponent multiple of 7.
55-
/// Suggested values are:
56-
/// - 256 (i.e., 2^7)
57-
/// - 16_386 (i.e., 2^14)
58-
/// - 2_097_152 (i.e., 2^21)
53+
/// As a consequence of wire zenoh's representation of sequence numbers it is
54+
/// recommended that the resolution is a power of 2 with exponent multiple of 7.
55+
/// Suggested values are:
56+
/// - 256 (i.e., 2^7)
57+
/// - 16_386 (i.e., 2^14)
58+
/// - 2_097_152 (i.e., 2^21)
5959
///
6060
/// This function will panic if `value` is out of bound w.r.t. `resolution`. That is if
6161
/// `value` is greater or equal than `resolution`.
@@ -173,14 +173,14 @@ impl SeqNumGenerator {
173173
///
174174
/// # Arguments
175175
/// * `initial_sn` - The initial sequence number. It is a good practice to initialize the
176-
/// sequence number generator with a random number
176+
/// sequence number generator with a random number
177177
///
178178
/// * `sn_resolution` - The resolution, in bits, to be used for the sequence number generator.
179-
/// As a consequence of wire zenoh's representation of sequence numbers
180-
/// this should be a multiple of 7.
179+
/// As a consequence of wire zenoh's representation of sequence numbers
180+
/// this should be a multiple of 7.
181181
///
182182
/// This function will panic if `value` is out of bound w.r.t. `resolution`. That is if
183-
/// `value` is greater or equal than `resolution`.
183+
/// `value` is greater or equal than `resolution`.
184184
///
185185
pub(crate) fn make(initial_sn: TransportSn, resolution: Bits) -> ZResult<SeqNumGenerator> {
186186
let sn = SeqNum::make(initial_sn, resolution)?;

plugins/zenoh-plugin-trait/src/vtable.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ impl<StartArgs, Instance> PluginVTable<StartArgs, Instance> {
5151
/// The functions declared by this macro are:
5252
///
5353
/// - `get_plugin_loader_version` - returns `PLUGIN_LOADER_VERSION` const of the crate. The [`PluginsManager`](crate::manager::PluginsManager)
54-
/// will check if this version is compatible with the host.
54+
/// will check if this version is compatible with the host.
5555
/// - `get_compatibility` - returns [`Compatibility`](crate::Compatibility) struct which contains all version information (Rust compiler version, features used, version of plugin's structures).
56-
/// The layout of this structure is guaranteed to be stable until the [`PLUGIN_LOADER_VERSION`](crate::PLUGIN_LOADER_VERSION) is changed,
57-
/// so it's safe to use it in the host after call to `get_plugin_loader_version` returns compatible version.
58-
/// Then the [`PluginsManager`](crate::manager::PluginsManager) compares the returned [`Compatibility`](crate::Compatibility) with it's own and decides if it can continue loading the plugin.
56+
/// The layout of this structure is guaranteed to be stable until the [`PLUGIN_LOADER_VERSION`](crate::PLUGIN_LOADER_VERSION) is changed,
57+
/// so it's safe to use it in the host after call to `get_plugin_loader_version` returns compatible version.
58+
/// Then the [`PluginsManager`](crate::manager::PluginsManager) compares the returned [`Compatibility`](crate::Compatibility) with it's own and decides if it can continue loading the plugin.
5959
/// - `load_plugin` - returns [`PluginVTable`](crate::PluginVTable) which is able to create plugin's instance.
6060
///
6161
#[macro_export]

0 commit comments

Comments
 (0)