docs: improve style

Author: saenai255

src/model/pacbuild.rs

@@ -23,6 +23,7 @@ pub struct PacBuild {
 
 /// Represents a `SemVer` version.
 /// # Examples
+///
 /// ```
 /// use libpacstall::model::Version;
 ///
@@ -32,6 +33,7 @@ pub type Version = String;
 
 /// Represents a `PacBuild` or Apt package name.
 /// # Examples
+///
 /// ```
 /// use libpacstall::model::PackageId;
 ///
@@ -40,6 +42,7 @@ pub type Version = String;
 pub type PackageId = String;
 /// Represents an URL
 /// # Examples
+///
 /// ```
 /// use libpacstall::model::URL;
 ///
@@ -48,6 +51,7 @@ pub type PackageId = String;
 pub type URL = String;
 /// Represents a file checksum
 /// # Examples
+///
 /// ```
 /// use libpacstall::model::Hash;
 ///
@@ -57,6 +61,7 @@ pub type Hash = String;
 
 /// Represents the install state of a package.
 /// # Examples
+///
 /// ```
 /// use chrono::NaiveDate;
 /// use libpacstall::model::InstallState;
@@ -87,6 +92,7 @@ impl InstallState {
 /// suffix.
 ///
 /// # Examples
+///
 /// ```
 /// use libpacstall::model::Kind;
 ///

src/store/base.rs

@@ -76,11 +76,19 @@ pub trait Base: Debug {
     /// * `StoreError::RepositoryConflict`
     fn update_repository(&mut self, repository: Repository) -> StoreResult<()>;
 
+    /// Find first by name in the given repository
     fn get_pacbuild_by_name_and_url(&self, name: &str, repository_url: &str) -> Option<&PacBuild>;
+
+    /// Find repository by name
     fn get_repository_by_name(&self, name: &str) -> Option<&Repository>;
+    /// Find repository by url
     fn get_repository_by_url(&self, url: &str) -> Option<&Repository>;
+
+    /// Find all repositories
     fn get_all_repositories(&self) -> Vec<&Repository>;
 
+    /// Find all packages that match all the given params. `None` params are
+    /// skipped.
     fn get_all_pacbuilds_by(
         &self,
         name_like: Option<&str>,
@@ -91,6 +99,7 @@ pub trait Base: Debug {
 }
 
 impl dyn Base {
+    /// Find all pacbuilds from all repositories
     pub fn get_all_pacbuilds(&self) -> Vec<&PacBuild> {
         self.get_all_pacbuilds_by(None, None, None, None)
     }