docs: disallow missing docs on crate level and allow where necessary (#…

…222)

src/cockroach_db/mod.rs

@@ -28,11 +28,15 @@ pub struct CockroachDb {
 }
 
 impl CockroachDb {
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+    #[allow(missing_docs)]
     pub fn new(cmd: CockroachDbCmd) -> Self {
         CockroachDb { cmd }
     }
 }
 
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+#[allow(missing_docs)]
 #[derive(Debug, Clone, Copy)]
 pub enum CockroachDbCmd {
     StartSingleNode { insecure: bool },

src/consul/mod.rs

@@ -28,6 +28,8 @@ pub struct Consul {
 }
 
 impl Consul {
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+    #[allow(missing_docs)]
     pub fn with_local_config(self, config: String) -> Self {
         let mut env_vars = self.env_vars;
         env_vars.insert(CONSUL_LOCAL_CONFIG.to_owned(), config);

src/dynamodb_local/mod.rs

@@ -4,6 +4,8 @@ const NAME: &str = "amazon/dynamodb-local";
 const TAG: &str = "2.0.0";
 const DEFAULT_WAIT: u64 = 3000;
 
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
 #[derive(Default, Debug, Clone)]
 pub struct DynamoDb {
     /// (remove if there is another variable)

src/elastic_search/mod.rs

@@ -21,6 +21,8 @@ pub const ELASTICSEARCH_API_PORT: ContainerPort = ContainerPort::Tcp(9200);
 /// [`Elasticsearch`]: https://elastic.co/
 pub const ELASTICSEARCH_INTER_NODE_PORT: ContainerPort = ContainerPort::Tcp(9300);
 
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
 #[derive(Debug, Default, Clone)]
 pub struct ElasticSearch {
     /// (remove if there is another variable)

src/elasticmq/mod.rs

@@ -3,6 +3,8 @@ use testcontainers::{core::WaitFor, Image};
 const NAME: &str = "softwaremill/elasticmq";
 const TAG: &str = "1.5.2";
 
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
 #[derive(Debug, Default, Clone)]
 pub struct ElasticMq {
     /// (remove if there is another variable)

src/google_cloud_sdk_emulators/mod.rs

@@ -35,13 +35,17 @@ pub const PUBSUB_PORT: u16 = 8085;
 /// [`Spanner`]: https://cloud.google.com/spanner
 pub const SPANNER_PORT: u16 = 9010;
 
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
 #[derive(Debug, Clone)]
 pub struct CloudSdkCmd {
     pub host: String,
     pub port: u16,
     pub emulator: Emulator,
 }
 
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
 #[derive(Debug, Clone, Eq, PartialEq)]
 pub enum Emulator {
     Bigtable,
@@ -81,6 +85,8 @@ impl IntoIterator for &CloudSdkCmd {
     }
 }
 
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
 #[derive(Debug, Clone)]
 pub struct CloudSdk {
     exposed_ports: Vec<ContainerPort>,
@@ -124,6 +130,8 @@ impl CloudSdk {
         }
     }
 
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+    #[allow(missing_docs)]
     pub fn bigtable() -> Self {
         Self::new(
             BIGTABLE_PORT,
@@ -132,6 +140,8 @@ impl CloudSdk {
         )
     }
 
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+    #[allow(missing_docs)]
     pub fn firestore() -> Self {
         Self::new(
             FIRESTORE_PORT,
@@ -140,6 +150,8 @@ impl CloudSdk {
         )
     }
 
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+    #[allow(missing_docs)]
     pub fn datastore(project: impl Into<String>) -> Self {
         let project = project.into();
         Self::new(
@@ -149,6 +161,8 @@ impl CloudSdk {
         )
     }
 
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+    #[allow(missing_docs)]
     pub fn pubsub() -> Self {
         Self::new(
             PUBSUB_PORT,
@@ -157,6 +171,8 @@ impl CloudSdk {
         )
     }
 
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+    #[allow(missing_docs)]
     pub fn spanner() -> Self {
         Self::new(
             SPANNER_PORT, // gRPC port

src/k3s/mod.rs

@@ -70,12 +70,16 @@ pub struct K3s {
     cmd: K3sCmd,
 }
 
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
 #[derive(Debug, Clone)]
 pub struct K3sCmd {
     snapshotter: String,
 }
 
 impl K3sCmd {
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+    #[allow(missing_docs)]
     pub fn with_snapshotter(self, snapshotter: impl Into<String>) -> Self {
         Self {
             snapshotter: snapshotter.into(),
@@ -130,6 +134,8 @@ impl Image for K3s {
 }
 
 impl K3s {
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+    #[allow(missing_docs)]
     pub fn with_conf_mount(mut self, conf_mount_path: impl AsRef<Path>) -> Self {
         self.env_vars
             .insert(String::from("K3S_KUBECONFIG_MODE"), String::from("644"));
@@ -142,6 +148,8 @@ impl K3s {
         }
     }
 
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+    #[allow(missing_docs)]
     pub fn read_kube_config(&self) -> io::Result<String> {
         let k3s_conf_file_path = self
             .conf_mount

src/kafka/confluent.rs

@@ -18,6 +18,8 @@ pub const KAFKA_PORT: ContainerPort = ContainerPort::Tcp(9093);
 /// [`Zookeeper`]: https://zookeeper.apache.org/
 pub const ZOOKEEPER_PORT: ContainerPort = ContainerPort::Tcp(2181);
 
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
 #[derive(Debug, Clone)]
 pub struct Kafka {
     env_vars: HashMap<String, String>,

src/lib.rs

@@ -1,3 +1,5 @@
+// let's document our code for other/future developers
+#![deny(missing_docs)]
 #![cfg_attr(docsrs, deny(rustdoc::broken_intra_doc_links))]
 #![cfg_attr(docsrs, feature(doc_cfg))]
 #![doc(

src/minio/mod.rs

@@ -8,6 +8,8 @@ const TAG: &str = "RELEASE.2022-02-07T08-17-33Z";
 const DIR: &str = "/data";
 const CONSOLE_ADDRESS: &str = ":9001";
 
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
 #[derive(Debug, Clone)]
 pub struct MinIO {
     env_vars: HashMap<String, String>,
@@ -29,10 +31,18 @@ impl Default for MinIO {
     }
 }
 
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
 #[derive(Debug, Clone)]
 pub struct MinIOServerCmd {
+    #[allow(missing_docs)]
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
     pub dir: String,
+    #[allow(missing_docs)]
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
     pub certs_dir: Option<String>,
+    #[allow(missing_docs)]
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
     pub json_log: bool,
 }
 

src/mongo/mod.rs

@@ -6,29 +6,32 @@ use testcontainers::{
 const NAME: &str = "mongo";
 const TAG: &str = "5.0.6";
 
-#[derive(Debug, Clone)]
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+#[derive(Default, Debug, Clone)]
 enum InstanceKind {
+    #[default]
     Standalone,
     ReplSet,
 }
 
-impl Default for InstanceKind {
-    fn default() -> Self {
-        Self::Standalone
-    }
-}
-
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
 #[derive(Default, Debug, Clone)]
 pub struct Mongo {
     kind: InstanceKind,
 }
 
 impl Mongo {
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+    #[allow(missing_docs)]
     pub fn new() -> Self {
         Self {
             kind: InstanceKind::Standalone,
         }
     }
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+    #[allow(missing_docs)]
     pub fn repl_set() -> Self {
         Self {
             kind: InstanceKind::ReplSet,

src/mosquitto/mod.rs

@@ -26,6 +26,8 @@ use testcontainers::{core::WaitFor, Image};
 const NAME: &str = "eclipse-mosquitto";
 const TAG: &str = "2.0.18";
 
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
 #[derive(Debug, Default, Clone)]
 pub struct Mosquitto {
     /// (remove if there is another variable)

src/mssql_server/mod.rs

@@ -58,6 +58,8 @@ pub struct MssqlServer {
 impl MssqlServer {
     const NAME: &'static str = "mcr.microsoft.com/mssql/server";
     const TAG: &'static str = "2022-CU14-ubuntu-22.04";
+    /// Default Password for `MSSQL_SA_PASSWORD`.
+    /// If you want to set your own password, please use [`with_sa_password`]
     pub const DEFAULT_SA_PASSWORD: &'static str = "yourStrong(!)Password";
 
     /// Sets the password as `MSSQL_SA_PASSWORD`.

src/nats/mod.rs

@@ -13,18 +13,24 @@ pub struct Nats {
     cmd: NatsServerCmd,
 }
 
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
 #[derive(Default, Debug, Clone)]
 pub struct NatsServerCmd {
     user: Option<String>,
     pass: Option<String>,
 }
 
 impl NatsServerCmd {
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+    #[allow(missing_docs)]
     pub fn with_user(mut self, user: &str) -> Self {
         self.user = Some(user.to_owned());
         self
     }
 
+    // not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
+    #[allow(missing_docs)]
     pub fn with_password(mut self, password: &str) -> Self {
         self.pass = Some(password.to_owned());
         self

src/neo4j/mod.rs

@@ -59,7 +59,7 @@ pub enum Neo4jLabsPlugin {
     /// You can also use it to validate your graph against constraints expressed in [SHACL](https://www.w3.org/TR/shacl/) or to run basic inferencing.
     /// Please see [their documentation](https://neo4j.com/labs/neosemantics/) for furhter details
     NeoSemantics,
-    // Allows specifying other plugins
+    /// Allows specifying other plugins
     Custom(String),
 }
 

src/orientdb/mod.rs

@@ -5,6 +5,8 @@ use testcontainers::{core::WaitFor, Image};
 const NAME: &str = "orientdb";
 const TAG: &str = "3.2.19";
 
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
 #[derive(Debug, Default, Clone)]
 pub struct OrientDb {
     /// (remove if there is another variable)

src/parity_parity/mod.rs

@@ -5,6 +5,8 @@ use testcontainers::{core::WaitFor, Image};
 const NAME: &str = "parity/parity";
 const TAG: &str = "v2.5.0";
 
+#[allow(missing_docs)]
+// not having docs here is currently allowed to address the missing docs problem one place at a time. Helping us by documenting just one of these places helps other devs tremendously
 #[derive(Debug, Default, Clone)]
 pub struct ParityEthereum {
     /// (remove if there is another variable)