From 0afc0e0e9910990331073891c2dcbf42ff1c6ba2 Mon Sep 17 00:00:00 2001 From: Aravinth Manivannan Date: Mon, 2 Jan 2023 22:36:18 +0530 Subject: [PATCH] feat: re-export types and add module headers --- src/identities.rs | 1 + src/label.rs | 2 ++ src/lib.rs | 11 +++++++++++ src/reaction.rs | 1 + src/repository.rs | 1 + src/topic.rs | 1 + src/user.rs | 1 + 7 files changed, 18 insertions(+) diff --git a/src/identities.rs b/src/identities.rs index f0fb0a4..1363561 100644 --- a/src/identities.rs +++ b/src/identities.rs @@ -14,6 +14,7 @@ * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . */ +//! Pairs of identities mapping one forge to another. use serde::{Deserialize, Serialize}; /// Pairs of identities mapping one forge to another. The first element is the id in the source diff --git a/src/label.rs b/src/label.rs index 2061e6b..3227b0a 100644 --- a/src/label.rs +++ b/src/label.rs @@ -14,6 +14,8 @@ * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . */ +//! Label associated to an issue or a comment + use serde::{Deserialize, Serialize}; /// Label associated to an issue or a comment diff --git a/src/lib.rs b/src/lib.rs index d0dc8fb..6e36b67 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -14,9 +14,20 @@ * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . */ +//! # Welcome to F3 Documentation! +//! +//! Please refer to the [main documentation](https://f3.forgefriends.org/) for a complete overview. +//! This is an incomplete Rust port of the F3 library created by the ForgeFriends project. pub mod identities; pub mod label; pub mod reaction; pub mod repository; pub mod topic; pub mod user; + +pub use identities::Identities; +pub use label::Label; +pub use reaction::Reaction; +pub use repository::Repository; +pub use topic::Topic; +pub use user::User; diff --git a/src/reaction.rs b/src/reaction.rs index 4bbd665..b18f483 100644 --- a/src/reaction.rs +++ b/src/reaction.rs @@ -14,6 +14,7 @@ * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . */ +//! Reaction associated to an issue or a comment use serde::{Deserialize, Serialize}; /// Reaction associated to an issue or a comment diff --git a/src/repository.rs b/src/repository.rs index 9569940..dfde4e5 100644 --- a/src/repository.rs +++ b/src/repository.rs @@ -14,6 +14,7 @@ * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . */ +//! VCS repository relative to a project. use serde::{Deserialize, Serialize}; /// VCS repository relative to a project. diff --git a/src/topic.rs b/src/topic.rs index 6221517..3456b0d 100644 --- a/src/topic.rs +++ b/src/topic.rs @@ -14,6 +14,7 @@ * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . */ +//! A list of categories associated with a project. use serde::{Deserialize, Serialize}; /// A list of categories associated with a project. diff --git a/src/user.rs b/src/user.rs index e8938b0..f3cfc56 100644 --- a/src/user.rs +++ b/src/user.rs @@ -14,6 +14,7 @@ * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see . */ +//! A forge user use serde::{Deserialize, Serialize}; /// A forge user