From 4b86f8f1f3c1e11bebacd1b0de899ad9b18cbc56 Mon Sep 17 00:00:00 2001 From: Thijs Cadier Date: Sat, 26 Dec 2015 02:17:20 +0100 Subject: [PATCH] Tweak lib doc --- src/lib.rs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/lib.rs b/src/lib.rs index 85b959e..f2f3a04 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -5,7 +5,9 @@ //! underlying C driver in the recommended way specified in it's [documentation](http://api.mongodb.org/c/current/). //! //! To get started create a client pool wrapped in an `Arc` so we can share it between threads. Then pop a client from it -//! you can use to perform operations: +//! you can use to perform operations. +//! +//! # Example //! //! ``` //! use std::sync::Arc; @@ -18,7 +20,8 @@ //! client.get_server_status(None).unwrap(); //! ``` //! -//! See the documentation for the various modules to find out how you can use the driver. +//! See the documentation for the available modules to find out how you can use the driver beyond +//! this. extern crate libc; extern crate mongoc_sys as mongoc;