summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorErin Power <xampprocky@gmail.com>2020-05-22 02:47:18 +0200
committerErin Power <xampprocky@gmail.com>2020-05-22 02:47:18 +0200
commit83426d27f30d4b138b07897c1d97de85876ee5d9 (patch)
treef941d210a757f573e9af3b248e40dd83f2d294d9
parentf0099b436020c82471de3696b034c6a3e3091991 (diff)
Bump version and add documentation linksv0.3.0
-rw-r--r--Cargo.toml2
-rw-r--r--README.md24
-rw-r--r--src/api/current.rs9
-rw-r--r--src/lib.rs8
4 files changed, 34 insertions, 9 deletions
diff --git a/Cargo.toml b/Cargo.toml
index 561f66e..7b223ba 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,6 @@
[package]
name = "octocrab"
-version = "0.2.3"
+version = "0.3.0"
authors = ["XAMPPRocky <xampprocky@gmail.com>"]
edition = "2018"
readme = "README.md"
diff --git a/README.md b/README.md
index 27f32b8..32b8304 100644
--- a/README.md
+++ b/README.md
@@ -21,19 +21,27 @@ The semantic API provides strong typing around GitHub's API, as well as a
set of [`models`] that maps to GitHub's types. Currently the following
modules are available.
+- [`actions`] GitHub Actions
+- [`current`] Information about the current user.
- [`gitignore`] Gitignore templates
- [`issues`] Issues and related items, e.g. comments, labels, etc.
- [`markdown`] Rendering Markdown with GitHub
- [`orgs`] GitHub Organisations
- [`pulls`] Pull Requests
-
-[`models`]: https://docs.rs/octocrab/0.2.3/octocrab/models/index.html
-
-[`gitignore`]: https://docs.rs/octocrab/0.2.3/octocrab/gitignore/struct.GitignoreHandler.html
-[`markdown`]: https://docs.rs/octocrab/0.2.3/octocrab/gitignore/struct.MarkdownHandler.html
-[`issues`]: https://docs.rs/octocrab/0.2.3/octocrab/issues/struct.IssueHandler.html
-[`pulls`]: https://docs.rs/octocrab/0.2.3/octocrab/pulls/struct.PullRequestHandler.html
-[`orgs`]: https://docs.rs/octocrab/0.2.3/octocrab/orgs/struct.OrgHandler.html
+- [`repos`] Repositories
+- [`teams`] Teams
+
+[`models`]: https://docs.rs/octocrab/0.3.0/octocrab/models/index.html
+
+[`actions`]: https://docs.rs/octocrab/0.3.0/octocrab/actions/struct.ActionsHandler.html
+[`current`]: https://docs.rs/octocrab/0.3.0/octocrab/current/struct.CurrentAuthHandler.html
+[`gitignore`]: https://docs.rs/octocrab/0.3.0/octocrab/gitignore/struct.GitignoreHandler.html
+[`markdown`]: https://docs.rs/octocrab/0.3.0/octocrab/gitignore/struct.MarkdownHandler.html
+[`issues`]: https://docs.rs/octocrab/0.3.0/octocrab/issues/struct.IssueHandler.html
+[`pulls`]: https://docs.rs/octocrab/0.3.0/octocrab/pulls/struct.PullRequestHandler.html
+[`orgs`]: https://docs.rs/octocrab/0.3.0/octocrab/orgs/struct.OrgHandler.html
+[`repos`]: https://docs.rs/octocrab/0.3.0/octocrab/repos/struct.RepoHandler.html
+[`teams`]: https://docs.rs/octocrab/0.3.0/octocrab/teams/struct.TeamHandler.html
#### Getting a Pull Request
```rust
diff --git a/src/api/current.rs b/src/api/current.rs
index 7843c8b..38554df 100644
--- a/src/api/current.rs
+++ b/src/api/current.rs
@@ -1,5 +1,14 @@
+//! Get data about the currently authenticated user.
+
use crate::{models, Octocrab, Result};
+/// Handler for the current authenication API. **Note** All of the methods
+/// provided below require at least some authenication such as personal token
+/// in order to be used.
+///
+/// Created with [`Octocrab::current`].
+///
+/// [`Octocrab::current`]: ../struct.Octocrab.html#method.current
pub struct CurrentAuthHandler<'octo> {
crab: &'octo Octocrab,
}
diff --git a/src/lib.rs b/src/lib.rs
index 10f1844..51ff8e4 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -9,18 +9,26 @@
//! set of [`models`] that maps to GitHub's types. Currently the following
//! modules are available.
//!
+//! - [`actions`] GitHub Actions
+//! - [`current`] Information about the current user.
//! - [`gitignore`] Gitignore templates
//! - [`issues`] Issues and related items, e.g. comments, labels, etc.
//! - [`markdown`] Rendering Markdown with GitHub
//! - [`orgs`] GitHub Organisations
//! - [`pulls`] Pull Requests
+//! - [`repos`] Repositories
+//! - [`teams`] Teams
//!
+//! [`actions`]: ./actions/struct.ActionsHandler.html
+//! [`current`]: ./current/struct.CurrentAuthHandler.html
//! [`gitignore`]: ./gitignore/struct.GitignoreHandler.html
//! [`issues`]: ./issues/struct.IssueHandler.html
//! [`markdown`]: ./markdown/struct.MarkdownHandler.html
//! [`models`]: ./models/index.html
//! [`orgs`]: ./orgs/struct.OrgHandler.html
//! [`pulls`]: ./pulls/struct.PullRequestHandler.html
+//! [`repos`]: ./repos/struct.RepoHandler.html
+//! [`teams`]: ./teams/struct.TeamHandler.html
//!
//! #### Getting a Pull Request
//! ```no_run