aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Edgecumbe <git@esotericnonsense.com>2019-10-29 01:01:03 +0100
committerDaniel Edgecumbe <git@esotericnonsense.com>2019-10-29 01:01:03 +0100
commit2e748f1b41f25893c0db01b5ca49d03671fff1d7 (patch)
tree45540ddde81d2d5f439d0ec235843a92b4a7da31
parent5f80ee86f3e3153c865b97c9a247fe17047531b1 (diff)
Various documentation tweaks
-rw-r--r--README.md6
-rw-r--r--src/client.rs5
-rw-r--r--src/lib.rs16
3 files changed, 17 insertions, 10 deletions
diff --git a/README.md b/README.md
index cc967b8..0a8cbff 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,12 @@
-# `botfair` 0.3.0
+# `botfair` 0.3.99
The `botfair` crate provides Rust bindings for the Betfair SportsAPING.
Login and keep-alive are handled automatically by the BFClient.
-https://git.esotericnonsense.com/pub/botfair.git - main repository
+<https://git.esotericnonsense.com/pub/botfair.git> - main repository
-https://github.com/esotericnonsense/botfair.git - github repo, for PRs etc
+<https://github.com/esotericnonsense/botfair.git> - github repo, for PRs etc
## Warranty
diff --git a/src/client.rs b/src/client.rs
index 25ea157..bd2b759 100644
--- a/src/client.rs
+++ b/src/client.rs
@@ -75,7 +75,10 @@ impl BFCredentials {
}
/// A thread-safe client with automatic login implementing all methods of the
-/// Betfair APING.
+/// Betfair SportsAPING.
+///
+/// [`BFClient`](BFClient) implements Sync and so can safely be wrapped in an
+/// Arc for multithreaded use with the same session token.
pub struct BFClient {
client: reqwest::Client,
destructor: mpsc::SyncSender<()>,
diff --git a/src/lib.rs b/src/lib.rs
index ba2aa95..a91752f 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -14,19 +14,23 @@
// You should have received a copy of the GNU Affero General Public License
// along with botfair. If not, see <http://www.gnu.org/licenses/>.
-//! # botfair
+//! # `botfair` 0.3.99
//!
//! The `botfair` crate provides Rust bindings for the Betfair SportsAPING.
//! Login and keep-alive are handled automatically by the BFClient.
//!
-//! The BFClient class implements Sync and so can safely be wrapped in an Arc
-//! for multithreaded use with the same session token.
+//! See the [`BFClient`](BFClient) documentation for methods.
+//!
+//! [`BFClient`](BFClient) implements Sync and so can safely be wrapped in an
+//! Arc for multithreaded use with the same session token.
//!
//! ## Warranty
//!
-//! > This program is distributed in the hope that it will be useful,
-//! > but WITHOUT ANY WARRANTY; without even the implied warranty of
-//! > MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//! ```text
+//! This program is distributed in the hope that it will be useful,
+//! but WITHOUT ANY WARRANTY; without even the implied warranty of
+//! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+//! ```
//!
//! Paid support, consulting, and contracting services are available.
//!