[pbs-devel] applied-series: [PATCH backup 1/3] docs: remove empty lines in doc strings

[Fabian Grünbichler]

thanks!

On December 2, 2024 2:10 pm, Maximiliano Sandoval wrote:
> Fixes the clippy lint:
> 
> ```
> warning: empty line after doc comment
>    --> src/tape/pool_writer/mod.rs:441:5
>     |
> 441 | /     /// updated.
> 442 | |
>     | |_
> ...
> 448 | /     pub fn append_snapshot_archive(
> 449 | |         &mut self,
> 450 | |         snapshot_reader: &SnapshotReader,
> 451 | |     ) -> Result<(bool, usize), Error> {
>     | |_____________________________________- the comment documents this method
>     |
>     = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#empty_line_after_doc_comments
>     = help: if the empty line is unintentional remove it
> help: if the documentation should include the empty line include it in the comment
>     |
> 442 |     ///
>     |
> ```
> 
> Signed-off-by: Maximiliano Sandoval <m.sandoval at proxmox.com>
> ---
>  pbs-client/src/catalog_shell.rs | 1 -
>  pbs-datastore/src/chunker.rs    | 1 -
>  src/tape/pool_writer/mod.rs     | 4 ++--
>  3 files changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/pbs-client/src/catalog_shell.rs b/pbs-client/src/catalog_shell.rs
> index 550daf56b..20f323a22 100644
> --- a/pbs-client/src/catalog_shell.rs
> +++ b/pbs-client/src/catalog_shell.rs
> @@ -303,7 +303,6 @@ async fn restore_command(target: String, pattern: Option<String>) -> Result<(),
>  /// The `Path` type's component iterator does not tell us anything about trailing slashes or
>  /// trailing `Component::CurDir` entries. Since we only support regular paths we'll roll our own
>  /// here:
> -
>  pub struct Shell {
>      /// Readline instance handling input and callbacks
>      rl: rustyline::Editor<CliHelper>,
> diff --git a/pbs-datastore/src/chunker.rs b/pbs-datastore/src/chunker.rs
> index ecdbca296..bf1e8d8df 100644
> --- a/pbs-datastore/src/chunker.rs
> +++ b/pbs-datastore/src/chunker.rs
> @@ -30,7 +30,6 @@ pub trait Chunker {
>  /// information please take a look at the [Rolling
>  /// Hash](https://en.wikipedia.org/wiki/Rolling_hash) article from
>  /// Wikipedia.
> -
>  pub struct ChunkerImpl {
>      h: u32,
>      window_size: usize,
> diff --git a/src/tape/pool_writer/mod.rs b/src/tape/pool_writer/mod.rs
> index 9731e1cc8..3114ec061 100644
> --- a/src/tape/pool_writer/mod.rs
> +++ b/src/tape/pool_writer/mod.rs
> @@ -332,7 +332,7 @@ impl PoolWriter {
>  
>      /// Move to EOM (if not already there), then write the current
>      /// catalog to the tape. On success, this return 'Ok(true)'.
> -
> +    ///
>      /// Please note that this may fail when there is not enough space
>      /// on the media (return value 'Ok(false, _)'). In that case, the
>      /// archive is marked incomplete. The caller should mark the media
> @@ -439,7 +439,7 @@ impl PoolWriter {
>      /// archive writing specified files (as .pxar) into it. On
>      /// success, this return 'Ok(true)' and the media catalog gets
>      /// updated.
> -
> +    ///
>      /// Please note that this may fail when there is not enough space
>      /// on the media (return value 'Ok(false, _)'). In that case, the
>      /// archive is marked incomplete, and we do not use it. The caller
> -- 
> 2.39.5
> 
> 
> 
> _______________________________________________
> pbs-devel mailing list
> pbs-devel at lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
> 
> 
>