Steve Losh avatar Steve Losh committed da9ae58

Mention desugaring in docstrings.

Comments (0)

Files changed (5)

metrics-clojure-core/src/metrics/counters.clj

 
 
 (defmacro defcounter
-  "Define a new Counter metric with the given title."
+  "Define a new Counter metric with the given title.
+
+  The title uses some basic desugaring to let you concisely define metrics:
+
+    ; Define a counter titled \"default.default.foo\" into var foo
+    (defcounter foo)
+    (defcounter \"foo\")
+
+    ; Define a counter titled \"a.b.c\" into var c
+    (defcounter [a b c])
+    (defcounter [\"a\" \"b\" \"c\"])
+    (defcounter [a \"b\" c])
+  "
   [title]
   (let [[s title] (desugared-title title)]
     `(def ~s (counter ~title))))

metrics-clojure-core/src/metrics/gauges.clj

   "Define a new Gauge metric with the given title.
 
   The rest of the arguments may be a body form or function to call to
-  retrieve the value of the Gauge."
+  retrieve the value of the Gauge.
+
+  The title uses some basic desugaring to let you concisely define metrics:
+
+    ; Define a gauge titled \"default.default.foo\" into var foo
+    (defgauge foo ,,,)
+    (defgauge \"foo\" ,,,)
+
+    ; Define a gauge titled \"a.b.c\" into var c
+    (defgauge [a b c] ,,,)
+    (defgauge [\"a\" \"b\" \"c\"] ,,,)
+    (defgauge [a \"b\" c] ,,,)
+  "
   [title & [b & bs :as body]]
   (let [[s title] (desugared-title title)]
     (if (and (empty? bs)

metrics-clojure-core/src/metrics/histograms.clj

 
 
 (defmacro defhistogram
-  "Define a Histogram metric with the given title."
+  "Define a Histogram metric with the given title.
+  
+  The title uses some basic desugaring to let you concisely define metrics:
+
+    ; Define a histogram titled \"default.default.foo\" into var foo
+    (defhistogram foo)
+    (defhistogram \"foo\")
+
+    ; Define a histogram titled \"a.b.c\" into var c
+    (defhistogram [a b c])
+    (defhistogram [\"a\" \"b\" \"c\"])
+    (defhistogram [a \"b\" c])
+  "
   [title & args]
   (let [[s title] (desugared-title title)]
     `(def ~s (histogram ~title ~@args))))

metrics-clojure-core/src/metrics/meters.clj

 
 
 (defmacro defmeter
-  "Define a new Meter metric with a given title and event type."
+  "Define a new Meter metric with a given title and event type.
+
+  The title uses some basic desugaring to let you concisely define metrics:
+
+    ; Define a meter titled \"default.default.foo\" into var foo
+    (defmeter foo ,,,)
+    (defmeter \"foo\" ,,,)
+
+    ; Define a meter titled \"a.b.c\" into var c
+    (defmeter [a b c] ,,,)
+    (defmeter [\"a\" \"b\" \"c\"] ,,,)
+    (defmeter [a \"b\" c] ,,,)
+  "
   [title event-type]
   (let [[s title] (desugared-title title)]
     `(def ~s (meter ~title ~event-type))))

metrics-clojure-core/src/metrics/timers.clj

 
 
 (defmacro deftimer
-  "Define a new Timer metric with the given title."
+  "Define a new Timer metric with the given title.
+
+  The title uses some basic desugaring to let you concisely define metrics:
+
+    ; Define a timer titled \"default.default.foo\" into var foo
+    (deftimer foo)
+    (deftimer \"foo\")
+
+    ; Define a timer titled \"a.b.c\" into var c
+    (deftimer [a b c])
+    (deftimer [\"a\" \"b\" \"c\"])
+    (deftimer [a \"b\" c])
+  "
   [title]
   (let [[s title] (desugared-title title)]
     `(def ~s (timer ~title))))
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.