From 86d374718526a01fc6d4be1598953e00c0fda863 Mon Sep 17 00:00:00 2001
From: "niten\" (aider)" <niten@fudo.org>
Date: Sun, 8 Jun 2025 09:16:15 -0700
Subject: [PATCH] docs: Add docstrings for connect! and connect-json! functions
 in api.clj

---
 src/milquetoast/api.clj | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/milquetoast/api.clj b/src/milquetoast/api.clj
index 1d15397..9aa0d9e 100644
--- a/src/milquetoast/api.clj
+++ b/src/milquetoast/api.clj
@@ -42,6 +42,8 @@
   (core/subscribe-topic! client topic {:buffer-size buffer-size :qos qos}))
 
 (defn connect!
+  "Connects to the MQTT broker with the provided host, port, username, password, scheme, and verbosity level.
+  Returns a new MilquetoastClient instance."
   [& {:keys [host port username password scheme verbose]
       :or   {verbose false
              scheme  :tcp}}]
@@ -52,6 +54,8 @@
                    :verbose    verbose)))
 
 (defn connect-json!
+  "Connects to the MQTT broker with the provided host, port, username, password, scheme, and verbosity level.
+  Returns a new MilquetoastJsonClient instance."
   [& {:keys [host port username password scheme verbose]
       :or   {verbose false
              scheme  :tcp}}]