doc comment

diff --git a/crates/ra_vfs/src/lib.rs b/crates/ra_vfs/src/lib.rs
index 20482c396b2e29e2224705622d80a1e0de4bfc9b..6c1af5ef999248bab052caf32fcab39a590de52d 100644 (file)
--- a/crates/ra_vfs/src/lib.rs
+++ b/crates/ra_vfs/src/lib.rs
@@ -212,6 +212,7 @@ pub fn commit_changes(&mut self) -> Vec<VfsChange> {
         mem::replace(&mut self.pending_changes, Vec::new())
     }
 
+    /// Sutdown the VFS and terminate the background watching thread.
     pub fn shutdown(self) -> thread::Result<()> {
         let _ = self.worker.shutdown();
         self.worker_handle.shutdown()