Skip to content

Commit 700ff7a

Browse files
MrLotUMrLotU
committed
Docs & fix tests
1 parent 89bf1dd commit 700ff7a

File tree

23 files changed

+127
-107
lines changed

23 files changed

+127
-107
lines changed

‎circle.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ jobs:
1111
- run: swift test
1212
swift5:
1313
docker:
14-
- image: swift:5
14+
- image: swift:5.0
1515
steps:
1616
- checkout
1717
- run: apt-get update; apt-get install -y libssl-dev zlib1g-dev

‎docs/Classes.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ <h4>Declaration</h4>
233233
</div>
234234
</div>
235235
<div class="slightly-smaller">
236-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L6-L166">Show on GitHub</a>
236+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L6-L171">Show on GitHub</a>
237237
</div>
238238
</section>
239239
</div>
@@ -255,7 +255,7 @@ <h4>Declaration</h4>
255255
<section class="section">
256256
<div class="pointer"></div>
257257
<div class="abstract">
258-
<p>Prometheus Counter metric</p>
258+
<p>Prometheus Histogram metric</p>
259259

260260
<p>See <a href="https://prometheus.io/docs/concepts/metric_types/#Histogram">https://prometheus.io/docs/concepts/metric_types/#Histogram</a></p>
261261

@@ -270,7 +270,7 @@ <h4>Declaration</h4>
270270
</div>
271271
</div>
272272
<div class="slightly-smaller">
273-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Histogram.swift#L23-L150">Show on GitHub</a>
273+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Histogram.swift#L23-L151">Show on GitHub</a>
274274
</div>
275275
</section>
276276
</div>

‎docs/Classes/PromGauge.html‎

Lines changed: 43 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ <h4>Return Value</h4>
295295
<p>Newline seperated Prometheus formatted metric string</p>
296296
</div>
297297
<div class="slightly-smaller">
298-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L50-L68">Show on GitHub</a>
298+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L51-L69">Show on GitHub</a>
299299
</div>
300300
</section>
301301
</div>
@@ -357,7 +357,7 @@ <h4>Parameters</h4>
357357
</table>
358358
</div>
359359
<div class="slightly-smaller">
360-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L77-L87">Show on GitHub</a>
360+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L78-L88">Show on GitHub</a>
361361
</div>
362362
</section>
363363
</div>
@@ -415,11 +415,23 @@ <h4>Parameters</h4>
415415
</div>
416416
</td>
417417
</tr>
418+
<tr>
419+
<td>
420+
<code>
421+
<em>done</em>
422+
</code>
423+
</td>
424+
<td>
425+
<div>
426+
<p>Completion handler</p>
427+
</div>
428+
</td>
429+
</tr>
418430
</tbody>
419431
</table>
420432
</div>
421433
<div class="slightly-smaller">
422-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L96-L108">Show on GitHub</a>
434+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L98-L110">Show on GitHub</a>
423435
</div>
424436
</section>
425437
</div>
@@ -465,11 +477,23 @@ <h4>Parameters</h4>
465477
</div>
466478
</td>
467479
</tr>
480+
<tr>
481+
<td>
482+
<code>
483+
<em>done</em>
484+
</code>
485+
</td>
486+
<td>
487+
<div>
488+
<p>Completion handler</p>
489+
</div>
490+
</td>
491+
</tr>
468492
</tbody>
469493
</table>
470494
</div>
471495
<div class="slightly-smaller">
472-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L116-L118">Show on GitHub</a>
496+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L119-L121">Show on GitHub</a>
473497
</div>
474498
</section>
475499
</div>
@@ -527,11 +551,23 @@ <h4>Parameters</h4>
527551
</div>
528552
</td>
529553
</tr>
554+
<tr>
555+
<td>
556+
<code>
557+
<em>done</em>
558+
</code>
559+
</td>
560+
<td>
561+
<div>
562+
<p>Completion handler</p>
563+
</div>
564+
</td>
565+
</tr>
530566
</tbody>
531567
</table>
532568
</div>
533569
<div class="slightly-smaller">
534-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L127-L139">Show on GitHub</a>
570+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L131-L143">Show on GitHub</a>
535571
</div>
536572
</section>
537573
</div>
@@ -581,7 +617,7 @@ <h4>Parameters</h4>
581617
</table>
582618
</div>
583619
<div class="slightly-smaller">
584-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L147-L149">Show on GitHub</a>
620+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L151-L153">Show on GitHub</a>
585621
</div>
586622
</section>
587623
</div>
@@ -634,7 +670,7 @@ <h4>Return Value</h4>
634670
<p>The value of the Gauge attached to the provided labels</p>
635671
</div>
636672
<div class="slightly-smaller">
637-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L157-L165">Show on GitHub</a>
673+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L162-L170">Show on GitHub</a>
638674
</div>
639675
</section>
640676
</div>

‎docs/Classes/PromHistogram.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ <h1>PromHistogram</h1>
165165

166166
</div>
167167
</div>
168-
<p>Prometheus Counter metric</p>
168+
<p>Prometheus Histogram metric</p>
169169

170170
<p>See <a href="https://prometheus.io/docs/concepts/metric_types/#Histogram">https://prometheus.io/docs/concepts/metric_types/#Histogram</a></p>
171171

‎docs/Enums.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ <h4>Declaration</h4>
194194
</div>
195195
</div>
196196
<div class="slightly-smaller">
197-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L2-L13">Show on GitHub</a>
197+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L2-L11">Show on GitHub</a>
198198
</div>
199199
</section>
200200
</div>

‎docs/Enums/MetricType.html‎

Lines changed: 0 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -294,36 +294,6 @@ <h4>Declaration</h4>
294294
</section>
295295
</div>
296296
</li>
297-
<li class="item">
298-
<div>
299-
<code>
300-
<a name="/s:10Prometheus10MetricTypeO4infoyA2CmF"></a>
301-
<a name="//apple_ref/swift/Element/info" class="dashAnchor"></a>
302-
<a class="token" href="#/s:10Prometheus10MetricTypeO4infoyA2CmF">info</a>
303-
</code>
304-
</div>
305-
<div class="height-container">
306-
<div class="pointer-container"></div>
307-
<section class="section">
308-
<div class="pointer"></div>
309-
<div class="abstract">
310-
<p>See `PromInfo</p>
311-
312-
</div>
313-
<div class="declaration">
314-
<h4>Declaration</h4>
315-
<div class="language">
316-
<p class="aside-title">Swift</p>
317-
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">info</span></code></pre>
318-
319-
</div>
320-
</div>
321-
<div class="slightly-smaller">
322-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L12">Show on GitHub</a>
323-
</div>
324-
</section>
325-
</div>
326-
</li>
327297
</ul>
328298
</div>
329299
</div>

‎docs/Protocols.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ <h4>Declaration</h4>
231231
</div>
232232
</div>
233233
<div class="slightly-smaller">
234-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L18-L29">Show on GitHub</a>
234+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L16-L27">Show on GitHub</a>
235235
</div>
236236
</section>
237237
</div>
@@ -262,7 +262,7 @@ <h4>Declaration</h4>
262262
</div>
263263
</div>
264264
<div class="slightly-smaller">
265-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L39-L42">Show on GitHub</a>
265+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L37-L40">Show on GitHub</a>
266266
</div>
267267
</section>
268268
</div>

‎docs/Protocols/Metric.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ <h4>Declaration</h4>
201201
</div>
202202
</div>
203203
<div class="slightly-smaller">
204-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L20">Show on GitHub</a>
204+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L18">Show on GitHub</a>
205205
</div>
206206
</section>
207207
</div>
@@ -231,7 +231,7 @@ <h4>Declaration</h4>
231231
</div>
232232
</div>
233233
<div class="slightly-smaller">
234-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L22">Show on GitHub</a>
234+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L20">Show on GitHub</a>
235235
</div>
236236
</section>
237237
</div>
@@ -261,7 +261,7 @@ <h4>Declaration</h4>
261261
</div>
262262
</div>
263263
<div class="slightly-smaller">
264-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L24">Show on GitHub</a>
264+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L22">Show on GitHub</a>
265265
</div>
266266
</section>
267267
</div>
@@ -292,7 +292,7 @@ <h4>Declaration</h4>
292292
</div>
293293
</div>
294294
<div class="slightly-smaller">
295-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L28">Show on GitHub</a>
295+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L26">Show on GitHub</a>
296296
</div>
297297
</section>
298298
</div>

‎docs/Protocols/MetricLabels.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ <h4>Declaration</h4>
199199
</div>
200200
</div>
201201
<div class="slightly-smaller">
202-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L41">Show on GitHub</a>
202+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Metric.swift#L39">Show on GitHub</a>
203203
</div>
204204
</section>
205205
</div>

‎docs/docsets/Prometheus.docset/Contents/Resources/Documents/Classes.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ <h4>Declaration</h4>
233233
</div>
234234
</div>
235235
<div class="slightly-smaller">
236-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L6-L166">Show on GitHub</a>
236+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Gauge.swift#L6-L171">Show on GitHub</a>
237237
</div>
238238
</section>
239239
</div>
@@ -255,7 +255,7 @@ <h4>Declaration</h4>
255255
<section class="section">
256256
<div class="pointer"></div>
257257
<div class="abstract">
258-
<p>Prometheus Counter metric</p>
258+
<p>Prometheus Histogram metric</p>
259259

260260
<p>See <a href="https://prometheus.io/docs/concepts/metric_types/#Histogram">https://prometheus.io/docs/concepts/metric_types/#Histogram</a></p>
261261

@@ -270,7 +270,7 @@ <h4>Declaration</h4>
270270
</div>
271271
</div>
272272
<div class="slightly-smaller">
273-
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Histogram.swift#L23-L150">Show on GitHub</a>
273+
<a href="https://github.com/MrLotU/SwiftPrometheus/tree/master//Sources/Prometheus/MetricTypes/Histogram.swift#L23-L151">Show on GitHub</a>
274274
</div>
275275
</section>
276276
</div>

0 commit comments

Comments
 (0)