[nop] Update community adapter docstrings

taoensso · Aug 14, 2023 · b746080 · b746080
1 parent 523c5a3
commit b746080
Show file tree

Hide file tree

Showing 9 changed files with 22 additions and 16 deletions.
diff --git a/src/taoensso/sente/server_adapters/community/aleph.clj b/src/taoensso/sente/server_adapters/community/aleph.clj
@@ -1,5 +1,6 @@
 (ns taoensso.sente.server-adapters.community.aleph
-  "Sente server adapter for Aleph (https://github.com/ztellman/aleph)."
+  "Sente server adapter for Aleph,
+  Ref. <https://github.com/clj-commons/aleph>."
   {:author "Soren Macbeth (@sorenmacbeth)"}
   (:require
    [taoensso.sente.interfaces :as i]

diff --git a/src/taoensso/sente/server_adapters/community/dogfort.cljs b/src/taoensso/sente/server_adapters/community/dogfort.cljs
@@ -1,6 +1,6 @@
 (ns taoensso.sente.server-adapters.community.dogfort
-  "Sente server adapter for Node.js with Dog Fort
-  (https://github.com/whamtet/dogfort)."
+  "Sente server adapter for Node.js with Dog Fort,
+  Ref. <https://github.com/whamtet/dogfort>."
   {:author "Matthew Molloy <@whamtet>"}
   (:require
    [taoensso.encore :as enc :refer-macros ()]

diff --git a/src/taoensso/sente/server_adapters/community/express.cljs b/src/taoensso/sente/server_adapters/community/express.cljs
@@ -1,5 +1,6 @@
 (ns taoensso.sente.server-adapters.community.express
-  "Sente server adapter for Node.js with Express (http://expressjs.com/).
+  "Sente server adapter for Node.js with Express,
+  Ref. <https://github.com/expressjs/express>.
 
   This adapter works differently that the others as Sente is
   expecting Ring requests but Express uses http.IncomingMessage.

diff --git a/src/taoensso/sente/server_adapters/community/generic_node.cljs b/src/taoensso/sente/server_adapters/community/generic_node.cljs
@@ -1,9 +1,9 @@
 (ns taoensso.sente.server-adapters.community.generic-node
   "Sente server adapter for Node.js using the `ws` and `http` libraries.
-  Ref. https://github.com/websockets/ws,
-       https://nodejs.org/api/http.html,
-       https://nodejs.org/en/docs/guides/anatomy-of-an-http-transaction/,
-       https://github.com/theasp/sente-nodejs-example."
+  Ref. <https://github.com/websockets/ws>,
+       <https://nodejs.org/api/http.html>,
+       <https://nodejs.org/en/docs/guides/anatomy-of-an-http-transaction>,
+       <https://github.com/theasp/sente-nodejs-example>."
   {:author "Andrew Phillips <@theasp>, Matthew Molloy <@whamtet>"}
   (:require
    [taoensso.encore :as enc]

diff --git a/src/taoensso/sente/server_adapters/community/immutant.clj b/src/taoensso/sente/server_adapters/community/immutant.clj
@@ -1,5 +1,6 @@
 (ns taoensso.sente.server-adapters.community.immutant
-  "Sente server adapter for Immutant v2+ (http://immutant.org/)."
+  "Sente server adapter for Immutant v2+,
+  Ref. <https://github.com/immutant/immutant>."
   {:author "Toby Crawley (@tobias)"}
   (:require
    [taoensso.encore :as enc]

diff --git a/src/taoensso/sente/server_adapters/community/macchiato.cljs b/src/taoensso/sente/server_adapters/community/macchiato.cljs
@@ -1,6 +1,6 @@
 (ns taoensso.sente.server-adapters.community.macchiato
-  "Sente server adapter for Node.js with the Macchiato Framework
-  (https://macchiato-framework.github.io/)."
+  "Sente server adapter for Node.js with the Macchiato Framework,
+  Ref. <https://github.com/macchiato-framework/macchiato-core>."
   {:author "Andrew Phillips <@theasp>"}
   (:require
    [taoensso.encore :as enc]

diff --git a/src/taoensso/sente/server_adapters/community/nginx_clojure.clj b/src/taoensso/sente/server_adapters/community/nginx_clojure.clj
@@ -1,6 +1,7 @@
-(ns taoensso.sente.server-adapters.community.nginx-clojure
-  "Sente server adapter for Nginx-Clojure v0.4.2+
-  (http://nginx-clojure.github.io/)."
+(ns ^:no-doc taoensso.sente.server-adapters.community.nginx-clojure
+  ;; `^:no-doc` needed to prevent broken cljdoc build
+  "Sente server adapter for Nginx-Clojure v0.4.2+.
+  Ref. <https://github.com/nginx-clojure/nginx-clojure>."
   {:author "Zhang Yuexiang (@xfeep)"}
   (:require
    [taoensso.encore :as enc]

diff --git a/src/taoensso/sente/server_adapters/community/undertow.clj b/src/taoensso/sente/server_adapters/community/undertow.clj
@@ -1,5 +1,6 @@
 (ns taoensso.sente.server-adapters.community.undertow
-  "Sente server adapter for ring-undertow-adapter."
+  "Sente server adapter for ring-undertow-adapter,
+  Ref. <https://github.com/luminus-framework/ring-undertow-adapter>."
   {:author "Nik Peric"}
   (:require
     [ring.adapter.undertow.websocket :as websocket]

diff --git a/src/taoensso/sente/server_adapters/http_kit.clj b/src/taoensso/sente/server_adapters/http_kit.clj
@@ -1,5 +1,6 @@
 (ns taoensso.sente.server-adapters.http-kit
-  "Sente server adapter for http-kit (http://www.http-kit.org/)."
+  "Sente server adapter for http-kit,
+  Ref. <https://github.com/http-kit/http-kit>."
   {:author "Peter Taoussanis (@ptaoussanis)"}
   (:require
    [taoensso.encore :as enc]