Fix doctest broken by 1.40 rustc update. Also add a gitignore file.

Summary: Pull Request resolved: #4

Differential Revision: D19193637

Pulled By: lukaspiatkowski

fbshipit-source-id: 3cb88a6f94022d5ffd5b6cc7d4f5af9df78f97f0

.gitignore

@@ -0,0 +1,22 @@
+# macOS metadata
+.DS_Store
+
+# Eclipse files
+.classpath
+.project
+.settings/
+
+# Vim swap files
+*.swp
+
+# Files generated by JetBrains IDEs, e.g. IntelliJ IDEA
+.idea/
+*.iml
+out/
+
+# VSCode files
+.vscode/
+
+target/
+Cargo.lock
+**/*.rs.bk

shed/failure_ext/src/chain/mod.rs

@@ -6,7 +6,7 @@
  * directory of this source tree.
  */
 
-//! See documentation of [Chain][chain::Chain] and [ChainExt][chain::ChainExt]
+//! See documentation of [Chain](crate::chain::Chain) and [ChainExt](crate::chain::ChainExt)
 
 use anyhow::Error;
 use std::error::Error as StdError;

shed/failure_ext/src/lib.rs

@@ -50,7 +50,7 @@ mod context_streams;
 pub use crate::context_futures::{FutureFailureErrorExt, FutureFailureExt};
 pub use crate::context_streams::{StreamFailureErrorExt, StreamFailureExt};
 
-/// Shallow wrapper struct around ['anyhow::Error`] with ['std::fmt::Display`]
+/// Shallow wrapper struct around [anyhow::Error] with [std::fmt::Display]
 /// implementation that shows the entire chain of errors
 pub struct DisplayChain<'a>(&'a Error);
 

shed/failure_ext/src/macros.rs

@@ -6,7 +6,8 @@
  * directory of this source tree.
  */
 
-/// Downcast matching
+/// Downcast matching.
+///
 /// Usage:
 /// ```
 /// # use anyhow::Error;
@@ -52,7 +53,8 @@ macro_rules! err_downcast_ref {
     }};
 }
 
-/// Downcast matching
+/// Downcast matching.
+///
 /// Usage:
 /// ```
 /// # use anyhow::Error;

shed/futures_ext/src/bounded_traversal/mod.rs

@@ -6,8 +6,9 @@
  * directory of this source tree.
  */
 
-//! Read the documentation of [bounded_traversal::bounded_traversal],
-//! [bounded_traversal::bounded_traversal_dag] and [bounded_traversal::bounded_traversal_stream]
+//! Read the documentation of [bounded_traversal](crate::bounded_traversal::bounded_traversal),
+//! [bounded_traversal_dag](crate::bounded_traversal::bounded_traversal_dag) and
+//! [bounded_traversal_stream](crate::bounded_traversal::bounded_traversal_stream)
 
 mod tree;
 pub use tree::bounded_traversal;

shed/futures_ext/src/lib.rs

@@ -961,7 +961,7 @@ where
     }
 }
 
-/// It's a combinator that converts Stream<A> into Stream<Vec<A>>.
+/// It's a combinator that converts `Stream<A>` into `Stream<Vec<A>>`.
 /// So interface is similar to `.chunks()` method, but there's an important difference:
 /// BatchStream won't wait until the whole batch fills up i.e. as soon as underlying stream
 /// return NotReady, then new batch is returned from BatchStream