diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ce57b95..a68d7f4 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -41,3 +41,9 @@ jobs: with: command: test args: --all-features + - name: Docs + uses: actions-rs/cargo@v1 + env: + NOTION_API_TOKEN: ${{ secrets.NOTION_API_TOKEN }} + with: + command: doc diff --git a/Cargo.toml b/Cargo.toml index f3f352b..307ed6b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,6 +3,7 @@ name = "notion" version = "0.0.1-beta.3" authors = ["Jake Swenson "] edition = "2018" +repository = "https://github.com/jakeswenson/notion" description = "A Notion Api Client" license = "MIT" diff --git a/src/lib.rs b/src/lib.rs index e059a48..c030d94 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -9,6 +9,7 @@ pub mod models; const NOTION_API_VERSION: &str = "2021-05-13"; +/// An wrapper Error type for all errors produced by the [`NotionApi`](NotionApi) client. #[derive(Debug, Snafu)] pub enum Error { #[snafu(display("Invalid Notion API Token: {}", source))] @@ -27,6 +28,8 @@ pub enum Error { JsonParseError { source: serde_json::Error }, } +/// Meant to be a helpful trait allowing anything that can be +/// identified by the specified [Type](Self::Type). pub trait Identifiable { // There should only be one way to identify an object type Type;