diff --git a/src/backup.rs b/src/backup.rs index 0f324bf..78840d6 100644 --- a/src/backup.rs +++ b/src/backup.rs @@ -79,10 +79,16 @@ impl BackupEngine { } } /// Restore from the latest backup - /// db_dir: input db directory - /// wal_dir: input wal directory - /// opts: restore options - /// example: + /// + /// # Arguments + /// + /// * `db_dir` - A path to the database directory + /// * `wal_dir` - A path to the wal directory + /// * `opts` - Restore options + /// + /// # Example + /// + /// ```ignore /// use rocksdb::backup::{BackupEngine, BackupEngineOptions}; /// let backup_opts = BackupEngineOptions::default(); /// let backup_engine = BackupEngine::open(&backup_opts, &backup_path).unwrap(); @@ -92,6 +98,7 @@ impl BackupEngine { /// error!("Failed to restore from the backup. Error:{:?}", e); /// return Err(e.to_string()); /// } + /// ``` pub fn restore_from_latest_backup, W: AsRef>( &mut self, db_dir: D,