chore(x): add doc lint (#95)

* chore(x): add doc lint

* chore(x): remove fix variant for make_docs_cmd

Author: notfilippo

Cargo.lock

@@ -36,7 +36,6 @@ rustdoc-args = ["--cfg", "docsrs"]
 
 [dev-dependencies]
 googletest = { workspace = true }
-rand = { workspace = true }
 insta = { workspace = true }
 
 [lints]

datasketches/Cargo.toml

@@ -23,7 +23,7 @@
 //!
 //! Currently, this module contains tables for common lg_k values (4-12). The full C++
 //! implementation has tables for lg_k 4-21. Additional tables can be found at:
-//! https://github.com/apache/datasketches-cpp/blob/5a055521/hll/include/CompositeInterpolationXTable-internal.hpp
+//! <https://github.com/apache/datasketches-cpp/blob/5a055521/hll/include/CompositeInterpolationXTable-internal.hpp>
 
 const NUM_X_VALUES: usize = 257;
 

datasketches/src/hll/composite_interpolation.rs

@@ -89,7 +89,7 @@ impl TDigestMut {
     ///
     /// # Errors
     ///
-    /// If k is less than 10, returns [`ErrorKind::InvalidArgument`].
+    /// If k is less than 10.
     ///
     /// # Examples
     ///

datasketches/src/tdigest/sketch.rs

@@ -66,6 +66,7 @@ impl CommandLint {
     fn run(self) {
         run_command(make_clippy_cmd(self.fix));
         run_command(make_format_cmd(self.fix));
+        run_command(make_docs_cmd());
         run_command(make_taplo_cmd(self.fix));
         run_command(make_typos_cmd());
         run_command(make_hawkeye_cmd(self.fix));
@@ -138,6 +139,20 @@ fn make_clippy_cmd(fix: bool) -> StdCommand {
     cmd
 }
 
+fn make_docs_cmd() -> StdCommand {
+    let mut cmd = find_command("cargo");
+    cmd.env("RUSTFLAGS", "--cfg docsrs");
+    cmd.env("RUSTDOCFLAGS", "-D warnings");
+    cmd.args([
+        "+nightly",
+        "doc",
+        "--package",
+        "datasketches",
+        "--all-features",
+    ]);
+    cmd
+}
+
 fn make_hawkeye_cmd(fix: bool) -> StdCommand {
     ensure_installed("hawkeye", "hawkeye");
     let mut cmd = find_command("hawkeye");