proxmox-mirrors/proxmox-backup
1
0
Fork 1
mirror of https://git.proxmox.com/git/proxmox-backup synced 2025-11-02 15:18:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: remove empty lines in doc strings

Browse Source 
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@proxmox.com>
This commit is contained in:
Maximiliano Sandoval 2024-12-02 14:10:06 +01:00 committed by Fabian Grünbichler
parent 0083e7ac05
commit 47a29b1896
3 changed files with 2 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
pbs-client/src/catalog_shell.rs
View File

@ -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 /// 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 /// trailing `Component::CurDir` entries. Since we only support regular paths we'll roll our own
/// here: /// here:
pub struct Shell { pub struct Shell {
/// Readline instance handling input and callbacks /// Readline instance handling input and callbacks
rl: rustyline::Editor<CliHelper>, rl: rustyline::Editor<CliHelper>,

1
pbs-datastore/src/chunker.rs
View File

@ -30,7 +30,6 @@ pub trait Chunker {
/// information please take a look at the [Rolling /// information please take a look at the [Rolling
/// Hash](https://en.wikipedia.org/wiki/Rolling_hash) article from /// Hash](https://en.wikipedia.org/wiki/Rolling_hash) article from
/// Wikipedia. /// Wikipedia.
pub struct ChunkerImpl { pub struct ChunkerImpl {
h: u32, h: u32,
window_size: usize, window_size: usize,

4
src/tape/pool_writer/mod.rs
View File

@ -332,7 +332,7 @@ impl PoolWriter {
/// Move to EOM (if not already there), then write the current /// Move to EOM (if not already there), then write the current
/// catalog to the tape. On success, this return 'Ok(true)'. /// catalog to the tape. On success, this return 'Ok(true)'.
///
/// Please note that this may fail when there is not enough space /// Please note that this may fail when there is not enough space
/// on the media (return value 'Ok(false, _)'). In that case, the /// on the media (return value 'Ok(false, _)'). In that case, the
/// archive is marked incomplete. The caller should mark the media /// 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 /// archive writing specified files (as .pxar) into it. On
/// success, this return 'Ok(true)' and the media catalog gets /// success, this return 'Ok(true)' and the media catalog gets
/// updated. /// updated.
///
/// Please note that this may fail when there is not enough space /// Please note that this may fail when there is not enough space
/// on the media (return value 'Ok(false, _)'). In that case, the /// on the media (return value 'Ok(false, _)'). In that case, the
/// archive is marked incomplete, and we do not use it. The caller /// archive is marked incomplete, and we do not use it. The caller