Collector + directory doc fixes (#1247)

* doc(collector)

* doc(directory)

* doc(misc)

* wording

common/src/writer.rs

@@ -54,7 +54,7 @@ impl<W: TerminatingWrite> TerminatingWrite for CountingWriter<W> {
     }
 }
 
-/// Struct used to prevent from calling [`terminate_ref`](trait.TerminatingWrite#method.terminate_ref) directly
+/// Struct used to prevent from calling [`terminate_ref`](trait.TerminatingWrite.html#tymethod.terminate_ref) directly
 ///
 /// The point is that while the type is public, it cannot be built by anyone
 /// outside of this module.

ownedbytes/src/lib.rs

@@ -97,7 +97,6 @@ impl OwnedBytes {
 
     /// Drops the left most `advance_len` bytes.
     ///
-    /// See also [.clip(clip_len: usize))](#method.clip).
     #[inline]
     pub fn advance(&mut self, advance_len: usize) {
         self.data = &self.data[advance_len..]

src/collector/facet_collector.rs

@@ -400,7 +400,7 @@ impl<'a> Iterator for FacetChildIterator<'a> {
 
 impl FacetCounts {
     /// Returns an iterator over all of the facet count pairs inside this result.
-    /// See the documentation for `FacetCollector` for a usage example.
+    /// See the documentation for [FacetCollector] for a usage example.
     pub fn get<T>(&self, facet_from: T) -> FacetChildIterator<'_>
     where
         Facet: From<T>,
@@ -421,7 +421,7 @@ impl FacetCounts {
     }
 
     /// Returns a vector of top `k` facets with their counts, sorted highest-to-lowest by counts.
-    /// See the documentation for `FacetCollector` for a usage example.
+    /// See the documentation for [FacetCollector] for a usage example.
     pub fn top_k<T>(&self, facet: T, k: usize) -> Vec<(&Facet, u64)>
     where
         Facet: From<T>,

src/collector/filter_collector_wrapper.rs

@@ -16,7 +16,7 @@ use crate::fastfield::{DynamicFastFieldReader, FastFieldReader, FastValue};
 use crate::schema::Field;
 use crate::{Score, SegmentReader, TantivyError};
 
-/// The `FilterCollector` collector filters docs using a fast field value and a predicate.
+/// The `FilterCollector` filters docs using a fast field value and a predicate.
 /// Only the documents for which the predicate returned "true" will be passed on to the next collector.
 ///
 /// ```rust

src/directory/directory.rs

@@ -43,10 +43,8 @@ impl RetryPolicy {
 }
 
 /// The `DirectoryLock` is an object that represents a file lock.
-/// See  [`LockType`](struct.LockType.html)
 ///
-/// It is transparently associated to a lock file, that gets deleted
-/// on `Drop.` The lock is released automatically on `Drop`.
+/// It is associated to a lock file, that gets deleted on `Drop.`
 pub struct DirectoryLock(Box<dyn Send + Sync + 'static>);
 
 struct DirectoryLockGuard {

src/directory/directory_lock.rs

@@ -7,8 +7,8 @@ use std::path::PathBuf;
 /// [`LockParams`](./enum.LockParams.html).
 /// Tantivy itself uses only two locks but client application
 /// can use the directory facility to define their own locks.
-/// - [INDEX_WRITER_LOCK](./struct.INDEX_WRITER_LOCK.html)
-/// - [META_LOCK](./struct.META_LOCK.html)
+/// - [INDEX_WRITER_LOCK]
+/// - [META_LOCK]
 ///
 /// Check out these locks documentation for more information.
 ///

src/directory/mod.rs

@@ -1,6 +1,6 @@
 /*!
 
-WORM directory abstraction.
+WORM (Write Once Read Many) directory abstraction.
 
 */