chore(docs): fix spider cargo docs

spider-rs · Jan 8, 2025 · 076119f · 076119f
1 parent e39f5db
commit 076119f
Show file tree

Hide file tree

Showing 11 changed files with 49 additions and 50 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/spider/Cargo.toml b/spider/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "spider"
-version = "2.24.12"
+version = "2.24.13"
 authors = [
     "j-mendez <jeff@spider.cloud>"
 ]
@@ -11,7 +11,7 @@ keywords = ["crawler", "spider", "scraper"]
 categories = ["web-programming", "command-line-utilities"]
 license = "MIT"
 documentation = "https://docs.rs/spider"
-edition = "2018"
+edition = "2021"
 
 [badges]
 maintenance = { status = "as-is" }
@@ -61,7 +61,7 @@ string-interner = { version = "0.18", default-features = false, features = ["std
 httpdate = { version = "1", optional = true }
 rand = { version = "0.8", optional = true }
 serde_regex = { version = "1", optional = true }
-statrs = { version = "0.17", optional = true }
+statrs = { version = "0.18", optional = true }
 aho-corasick = { version = "1", optional = true }
 tracing = { version = "0.1", default-features = false, features = ["std"], optional = true }
 sysinfo = { version = "0.33", default-features = false, features = ["system"], optional = true }

diff --git a/spider/src/configuration.rs b/spider/src/configuration.rs
@@ -794,7 +794,7 @@ impl Configuration {
     }
 
     #[cfg(not(feature = "chrome"))]
-    /// Wait for idle dom mutations for target element. This method does nothing if the [chrome] feature is not enabled.
+    /// Wait for idle dom mutations for target element. This method does nothing if the `chrome` feature is not enabled.
     pub fn with_wait_for_idle_dom(
         &mut self,
         _wait_for_idle_dom: Option<WaitForSelector>,
@@ -803,7 +803,7 @@ impl Configuration {
     }
 
     #[cfg(feature = "chrome")]
-    /// Wait for a selector. This method does nothing if the [chrome] feature is not enabled.
+    /// Wait for a selector. This method does nothing if the `chrome` feature is not enabled.
     pub fn with_wait_for_selector(
         &mut self,
         wait_for_selector: Option<WaitForSelector>,

diff --git a/spider/src/website.rs b/spider/src/website.rs
@@ -340,7 +340,7 @@ impl Website {
         string_concat!(self.crawl_id, self.url.inner())
     }
 
-    /// Setup SQLite. This does nothing with [disk] flag enabled.
+    /// Setup SQLite. This does nothing with `disk` flag enabled.
     #[cfg(feature = "disk")]
     pub fn setup_disk(&mut self) {
         if !self.sqlite.pool_inited() {
@@ -349,17 +349,17 @@ impl Website {
         }
     }
 
-    /// Setup SQLite. This does nothing with [disk] flag enabled.
+    /// Setup SQLite. This does nothing with `disk` flag enabled.
     #[cfg(not(feature = "disk"))]
     pub fn setup_disk(&mut self) {}
 
-    /// Get the db pool. This does nothing with [disk] flag enabled.
+    /// Get the db pool. This does nothing with `disk` flag enabled.
     #[cfg(feature = "disk")]
     async fn get_db_pool(&self) -> &sqlx::SqlitePool {
         self.sqlite.get_db_pool().await
     }
 
-    /// Check if URL exists (ignore case). This does nothing with [disk] flag enabled.
+    /// Check if URL exists (ignore case). This does nothing with `disk` flag enabled.
     #[cfg(feature = "disk")]
     async fn is_allowed_disk(&self, url_to_check: &str) -> bool {
         if !self.sqlite.ready() {
@@ -372,33 +372,33 @@ impl Website {
         }
     }
 
-    /// Check if URL exists (ignore case). This does nothing with [disk] flag enabled.
+    /// Check if URL exists (ignore case). This does nothing with `disk` flag enabled.
     #[cfg(not(feature = "disk"))]
     async fn is_allowed_disk(&self, _url_to_check: &str) -> bool {
         true
     }
 
-    /// Clear the disk. This does nothing with [disk] flag enabled.
+    /// Clear the disk. This does nothing with `disk` flag enabled.
     #[cfg(feature = "disk")]
     async fn clear_disk(&self) {
         if self.sqlite.pool_inited() {
             let _ = DatabaseHandler::clear_table(self.get_db_pool().await).await;
         }
     }
 
-    /// Clear the disk. This does nothing with [disk] flag enabled.
+    /// Clear the disk. This does nothing with `disk` flag enabled.
     #[cfg(not(feature = "disk"))]
     async fn clear_disk(&self) {}
 
-    /// Insert a new URL to disk if it doesn't exist. This does nothing with [disk] flag enabled.
+    /// Insert a new URL to disk if it doesn't exist. This does nothing with `disk` flag enabled.
     #[cfg(feature = "disk")]
     async fn insert_url_disk(&self, new_url: &CaseInsensitiveString) {
         self.sqlite
             .insert_url(self.get_db_pool().await, new_url)
             .await
     }
 
-    /// Insert a new URL if it doesn't exist. This does nothing with [disk] flag enabled.
+    /// Insert a new URL if it doesn't exist. This does nothing with `disk` flag enabled.
     #[cfg(feature = "disk")]
     async fn insert_link(&mut self, new_url: CaseInsensitiveString) {
         let mem_load = crate::utils::detect_system::get_global_memory_state().await;
@@ -423,13 +423,13 @@ impl Website {
         }
     }
 
-    /// Insert a new URL if it doesn't exist. This does nothing with [disk] flag enabled.
+    /// Insert a new URL if it doesn't exist. This does nothing with `disk` flag enabled.
     #[cfg(not(feature = "disk"))]
     async fn insert_link(&mut self, link: CaseInsensitiveString) {
         self.links_visited.insert(link);
     }
 
-    /// Seed the DB and clear the Hashset. This does nothing with [disk] flag enabled.
+    /// Seed the DB and clear the Hashset. This does nothing with `disk` flag enabled.
     #[cfg(feature = "disk")]
     async fn seed(&mut self) -> Result<(), sqlx::Error> {
         let links = self.get_links();
@@ -790,13 +790,13 @@ impl Website {
         self.pages.as_ref()
     }
 
-    /// Links visited getter for disk. This does nothing with [disk] flag enabled.
+    /// Links visited getter for disk. This does nothing with `disk` flag enabled.
     #[cfg(not(feature = "disk"))]
     pub async fn get_links_disk(&self) -> HashSet<CaseInsensitiveString> {
         Default::default()
     }
 
-    /// Links visited getter for disk. This does nothing with [disk] flag enabled.
+    /// Links visited getter for disk. This does nothing with `disk` flag enabled.
     #[cfg(feature = "disk")]
     pub async fn get_links_disk(&self) -> HashSet<CaseInsensitiveString> {
         if self.sqlite.pool_inited() {
@@ -4311,7 +4311,7 @@ impl Website {
         self
     }
 
-    /// Wait for idle dom mutations for target element. This method does nothing if the [chrome] feature is not enabled.
+    /// Wait for idle dom mutations for target element. This method does nothing if the `chrome` feature is not enabled.
     pub fn with_wait_for_idle_dom(
         &mut self,
         wait_for_selector: Option<crate::configuration::WaitForSelector>,

diff --git a/spider_chrome/Cargo.toml b/spider_chrome/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "spider_chrome"
-version = "2.24.12"
+version = "2.24.13"
 rust-version = "1.70"
 authors = [
     "j-mendez <jeff@spider.cloud>"

diff --git a/spider_chrome/fetcher/src/browser/options.rs b/spider_chrome/fetcher/src/browser/options.rs
@@ -17,7 +17,7 @@ pub struct BrowserFetcherOptions {
 
     /// The host that will be used for downloading.
     ///
-    /// defaults to https://storage.googleapis.com
+    /// defaults to <https://storage.googleapis.com>
     pub(crate) host: String,
 
     /// The path to download browsers to.

diff --git a/spider_cli/Cargo.toml b/spider_cli/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "spider_cli"
-version = "2.24.12"
+version = "2.24.13"
 authors = [
     "j-mendez <jeff@spider.cloud>"
 ]

diff --git a/spider_transformations/Cargo.toml b/spider_transformations/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "spider_transformations"
-version = "2.24.12"
+version = "2.24.13"
 authors = [
     "j-mendez <jeff@spider.cloud>"
 ]

diff --git a/spider_transformations/src/html2text/render/text_renderer.rs b/spider_transformations/src/html2text/render/text_renderer.rs
@@ -258,7 +258,7 @@ impl<T: Debug + Eq + PartialEq + Clone + Default> TaggedLine<T> {
     }
 
     /// Iterator over TaggedLineElements
-    pub fn iter<'a>(&'a self) -> impl Iterator<Item = &TaggedLineElement<T>> + 'a {
+    pub fn iter<'a>(&'a self) -> impl Iterator<Item = &'a TaggedLineElement<T>> + 'a {
         self.v.iter()
     }
 

diff --git a/spider_utils/Cargo.toml b/spider_utils/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "spider_utils"
-version = "2.24.12"
+version = "2.24.13"
 authors = [
     "j-mendez <jeff@spider.cloud>"
 ]

diff --git a/spider_worker/Cargo.toml b/spider_worker/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "spider_worker"
-version = "2.24.12"
+version = "2.24.13"
 authors = [
     "j-mendez <jeff@spider.cloud>"
 ]