From 164b6b7f10e9f8e98dca3b33dd543fb84f57897b Mon Sep 17 00:00:00 2001
From: Matthias Beyer <mail@beyermatthias.de>
Date: Sat, 27 Jan 2018 12:10:01 +0100
Subject: [PATCH] Move documentation to appropriate place

---
 lib/core/libimagstore/src/store.rs | 22 ++++++++++------------
 1 file changed, 10 insertions(+), 12 deletions(-)

diff --git a/lib/core/libimagstore/src/store.rs b/lib/core/libimagstore/src/store.rs
index 9a41e75c..365576e0 100644
--- a/lib/core/libimagstore/src/store.rs
+++ b/lib/core/libimagstore/src/store.rs
@@ -455,9 +455,17 @@ impl Store {
         Walk::new(self.path().clone(), mod_name)
     }
 
-    /// Return the `FileLockEntry` and write to disk
+    /// Write (update) the `FileLockEntry` to disk
     ///
-    /// See `Store::_update()`.
+    /// # Return value
+    ///
+    /// On success: Entry
+    ///
+    /// On error:
+    ///  - UpdateCallError(LockPoisoned()) if the internal write lock cannot be aquierd.
+    ///  - IdNotFound() if the entry was not found in the stor
+    ///  - Errors Entry::verify() might return
+    ///  - Errors StoreEntry::write_entry() might return
     ///
     pub fn update<'a>(&'a self, entry: &mut FileLockEntry<'a>) -> Result<()> {
         debug!("Updating FileLockEntry at '{}'", entry.get_location());
@@ -471,16 +479,6 @@ impl Store {
     /// This method assumes that entry is dropped _right after_ the call, hence
     /// it is not public.
     ///
-    /// # Return value
-    ///
-    /// On success: Entry
-    ///
-    /// On error:
-    ///  - UpdateCallError(LockPoisoned()) if the internal write lock cannot be aquierd.
-    ///  - IdNotFound() if the entry was not found in the stor
-    ///  - Errors Entry::verify() might return
-    ///  - Errors StoreEntry::write_entry() might return
-    ///
     fn _update<'a>(&'a self, entry: &mut FileLockEntry<'a>, modify_presence: bool) -> Result<()> {
         let mut hsmap = self.entries.write().map_err(|_| SE::from_kind(SEK::LockPoisoned))?;