[nop] Update community appender docstrings

taoensso · Aug 14, 2023 · 4ad8e84 · 4ad8e84
1 parent ffd9eca
commit 4ad8e84
Show file tree

Hide file tree

Showing 15 changed files with 27 additions and 19 deletions.
diff --git a/deploy/src/taoensso/timbre/appenders/community/android_logcat.clj b/deploy/src/taoensso/timbre/appenders/community/android_logcat.clj
@@ -1,4 +1,5 @@
-(ns taoensso.timbre.appenders.community.android-logcat
+(ns ^:no-doc taoensso.timbre.appenders.community.android-logcat
+  ;; `^:no-doc` needed to prevent broken cljdoc build
   "Android LogCat appender. Requires Android runtime."
   {:author "Adam Clements (@AdamClements)"}
   (:require

diff --git a/deploy/src/taoensso/timbre/appenders/community/newrelic.clj b/deploy/src/taoensso/timbre/appenders/community/newrelic.clj
@@ -1,6 +1,7 @@
-(ns taoensso.timbre.appenders.community.newrelic
-  "New Relic appender. Requires an appropriate New Relic jar,
-  Ref. https://goo.gl/3Nv0QX."
+(ns ^:no-doc taoensso.timbre.appenders.community.newrelic
+  ;; `^:no-doc` needed to prevent broken cljdoc build
+  "New Relic appender.
+  Requires <https://github.com/newrelic/newrelic-java-agent>."
   {:author "Camilo Polymeris (@polymeris)"}
   (:import [com.newrelic.api.agent NewRelic]))
 

diff --git a/deploy/src/taoensso/timbre/appenders/community/zmq.clj b/deploy/src/taoensso/timbre/appenders/community/zmq.clj
@@ -1,5 +1,7 @@
-(ns taoensso.timbre.appenders.community.zmq
-  "ØMQ appender. Requires https://github.com/zeromq/cljzmq."
+(ns ^:no-doc taoensso.timbre.appenders.community.zmq
+  ;; `^:no-doc` needed to prevent broken cljdoc build
+  "ØMQ appender.
+  Requires <https://github.com/zeromq/cljzmq>."
   {:author "Angus Fletcher (@angusiguess)"}
   (:require
    [taoensso.encore :as enc]

diff --git a/src/taoensso/timbre/appenders/carmine.clj b/src/taoensso/timbre/appenders/carmine.clj
@@ -1,6 +1,6 @@
 (ns taoensso.timbre.appenders.carmine
   "Carmine (Redis) appender.
-  Requires https://github.com/ptaoussanis/carmine."
+  Requires <https://github.com/taoensso/carmine>."
   {:author "Peter Taoussanis (@ptaoussanis)"}
   (:require
    [taoensso.encore  :as enc :refer [have have?]]

diff --git a/src/taoensso/timbre/appenders/community/congomongo.clj b/src/taoensso/timbre/appenders/community/congomongo.clj
@@ -1,5 +1,6 @@
 (ns taoensso.timbre.appenders.community.congomongo
-  "MongoDB appender. Requires https://github.com/aboekhoff/congomongo."
+  "MongoDB appender.
+  Requires <https://github.com/congomongo/congomongo>."
   {:author "Emlyn Corrin (@emlyn)"}
   (:require [somnium.congomongo :as mongo]
             [taoensso.timbre    :as timbre]

diff --git a/src/taoensso/timbre/appenders/community/franzy.clj b/src/taoensso/timbre/appenders/community/franzy.clj
@@ -1,6 +1,6 @@
 (ns taoensso.timbre.appenders.community.franzy
   "Franzy (Kafka) appender.
-  Requires Franzy (https://github.com/ymilky/franzy."
+  Requires <https://github.com/ymilky/franzy>."
   {:author "Isaac Zeng (@gfZeng)"}
   (:require
    [franzy.serialization.serializers  :as serializers]

diff --git a/src/taoensso/timbre/appenders/community/node_spit.cljs b/src/taoensso/timbre/appenders/community/node_spit.cljs
@@ -1,5 +1,5 @@
 (ns taoensso.timbre.appenders.community.node-spit
-  "Requires https://github.com/pkpkpk/cljs-node-io."
+  "Requires <https://github.com/pkpkpk/cljs-node-io>."
   {:author "Mason Vines (@mavines)"}
   (:require
    [taoensso.encore   :as enc]

diff --git a/src/taoensso/timbre/appenders/community/postgresql.clj b/src/taoensso/timbre/appenders/community/postgresql.clj
@@ -1,7 +1,7 @@
 (ns taoensso.timbre.appenders.community.postgresql
   "JDBC PostgreSQL database appender.
-  Requires https://github.com/clojure/java.jdbc,
-           https://github.com/swaldman/c3p0."
+  Requires <https://github.com/clojure/java.jdbc>,
+           <https://github.com/swaldman/c3p0>."
   {:author "Yue Liu (@yuliu-mdsol)"}
   (:require
    [taoensso.timbre   :as timbre]

diff --git a/src/taoensso/timbre/appenders/community/rolling.clj b/src/taoensso/timbre/appenders/community/rolling.clj
@@ -1,6 +1,5 @@
 (ns taoensso.timbre.appenders.community.rolling
   "Rolling file appender."
-  {:author "Unknown - please let me know?"}
   (:require
    [clojure.java.io :as io]
    [taoensso.encore :as enc]

diff --git a/src/taoensso/timbre/appenders/community/sentry.clj b/src/taoensso/timbre/appenders/community/sentry.clj
@@ -1,5 +1,6 @@
 (ns taoensso.timbre.appenders.community.sentry
-  "Sentry appender. Requires https://github.com/sethtrain/raven-clj."
+  "Sentry appender.
+  Requires <https://github.com/sethtrain/raven-clj>."
   {:author "Samuel Otter (@samuelotter)"}
   (:require
    [taoensso.encore :as enc]

diff --git a/src/taoensso/timbre/appenders/community/server_socket.clj b/src/taoensso/timbre/appenders/community/server_socket.clj
@@ -1,6 +1,6 @@
 (ns taoensso.timbre.appenders.community.server-socket
   "TCP socket appender.
-  Requires https://github.com/technomancy/server-socket."
+  Requires <https://github.com/technomancy/server-socket>."
   {:author "Emlyn Corrin (@emlyn)"}
   (:require
    [taoensso.encore :as enc]

diff --git a/src/taoensso/timbre/appenders/community/slack.clj b/src/taoensso/timbre/appenders/community/slack.clj
@@ -1,5 +1,6 @@
 (ns taoensso.timbre.appenders.community.slack
-  "Slack appender. Requires https://github.com/julienXX/clj-slack."
+  "Slack appender.
+  Requires <https://github.com/julienXX/clj-slack>."
   {:author "Simon Belak (@sbelak)"}
   (:require
    [taoensso.timbre :as timbre]

diff --git a/src/taoensso/timbre/appenders/community/syslog_appender.clj b/src/taoensso/timbre/appenders/community/syslog_appender.clj
@@ -1,5 +1,5 @@
 (ns taoensso.timbre.appenders.community.syslog-appender
-  "Requires https://github.com/java-native-access/jna"
+  "Requires <https://github.com/java-native-access/jna>."
   {:author "Audrius Molis @audriu"
    :inspired-by "https://github.com/joshrotenberg/brolog"}
   (:require

diff --git a/src/taoensso/timbre/appenders/example.clj b/src/taoensso/timbre/appenders/example.clj
@@ -5,8 +5,9 @@
   PRs for new *dependency-free* community appenders welcome!
 
   NB See the `timbre/*config*` docstring for up-to-date info
-  Timbre's appender API."
+  Timbre's appender API.
 
+  Requires <https://github.com/<TODO>/<TODO>>."
   {:author "TODO Your Name (@your-github-username)"}
   (:require
    [taoensso.encore :as enc]

diff --git a/src/taoensso/timbre/appenders/postal.clj b/src/taoensso/timbre/appenders/postal.clj
@@ -1,5 +1,6 @@
 (ns taoensso.timbre.appenders.postal
-  "Email (Postal) appender. Requires https://github.com/drewr/postal."
+  "Email (Postal) appender.
+  Requires <https://github.com/drewr/postal>."
   {:author "Peter Taoussanis (@ptaoussanis)"}
   (:require
    [clojure.string     :as str]