From 815a0e577821a3876aa4c79c13200607acadcd2f Mon Sep 17 00:00:00 2001
From: Aleksey Kladov <aleksey.kladov@gmail.com>
Date: Wed, 19 Dec 2018 10:29:48 +0300
Subject: doc comment

---
 crates/ra_vfs/src/lib.rs | 1 +
 1 file changed, 1 insertion(+)

(limited to 'crates/ra_vfs/src/lib.rs')

diff --git a/crates/ra_vfs/src/lib.rs b/crates/ra_vfs/src/lib.rs
index 20482c396..6c1af5ef9 100644
--- a/crates/ra_vfs/src/lib.rs
+++ b/crates/ra_vfs/src/lib.rs
@@ -212,6 +212,7 @@ impl Vfs {
         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()
-- 
cgit v1.2.3