Browse Source

Fix method signatures when including docstrings.

pull/17/head
Fredrik Ekre 2 years ago
parent
commit
bb3165169c
No known key found for this signature in database
GPG Key ID: DE82E6D5E364C0A2
  1. 12
      docs/src/index.md
  2. 4
      src/Prometheus.jl

12
docs/src/index.md

@ -86,7 +86,7 @@ documentation](https://prometheus.io/docs/concepts/metric_types/#counter): @@ -86,7 +86,7 @@ documentation](https://prometheus.io/docs/concepts/metric_types/#counter):
```@docs
Prometheus.Counter(::String, ::String; kwargs...)
Prometheus.inc(::Prometheus.Counter, ::Any)
Prometheus.inc(::Prometheus.Counter, ::Real)
```
### Gauge
@ -103,9 +103,9 @@ documentation](https://prometheus.io/docs/concepts/metric_types/#gauge): @@ -103,9 +103,9 @@ documentation](https://prometheus.io/docs/concepts/metric_types/#gauge):
```@docs
Prometheus.Gauge(::String, ::String; kwargs...)
Prometheus.inc(::Prometheus.Gauge, ::Any)
Prometheus.dec(::Prometheus.Gauge, ::Any)
Prometheus.set(::Prometheus.Gauge, ::Any)
Prometheus.inc(::Prometheus.Gauge, ::Real)
Prometheus.dec(::Prometheus.Gauge, ::Real)
Prometheus.set(::Prometheus.Gauge, ::Real)
Prometheus.set_to_current_time(::Prometheus.Gauge)
Prometheus.@time
Prometheus.@inprogress
@ -122,7 +122,7 @@ documentation](https://prometheus.io/docs/concepts/metric_types/#histogram): @@ -122,7 +122,7 @@ documentation](https://prometheus.io/docs/concepts/metric_types/#histogram):
```@docs
Prometheus.Histogram(::String, ::String; kwargs...)
Prometheus.observe(::Prometheus.Histogram, ::Any)
Prometheus.observe(::Prometheus.Histogram, ::Real)
```
```@docs; canonical=false
Prometheus.@time
@ -141,7 +141,7 @@ documentation](https://prometheus.io/docs/concepts/metric_types/#summary): @@ -141,7 +141,7 @@ documentation](https://prometheus.io/docs/concepts/metric_types/#summary):
```@docs
Prometheus.Summary(::String, ::String; kwargs...)
Prometheus.observe(::Prometheus.Summary, ::Any)
Prometheus.observe(::Prometheus.Summary, ::Real)
```
```@docs; canonical=false
Prometheus.@time

4
src/Prometheus.jl

@ -243,7 +243,7 @@ Construct a Gauge collector. @@ -243,7 +243,7 @@ Construct a Gauge collector.
skip registration.
**Methods**
- [`Prometheus.inc`](@ref inc(::Gauge, ::Any)): increment the value
- [`Prometheus.inc`](@ref inc(::Gauge, ::Real)): increment the value
of the gauge.
- [`Prometheus.dec`](@ref): decrement the value of the gauge.
- [`Prometheus.set`](@ref): set the value of the gauge.
@ -467,7 +467,7 @@ Construct a Summary collector. @@ -467,7 +467,7 @@ Construct a Summary collector.
skip registration.
**Methods**
- [`Prometheus.observe`](@ref observe(::Summary, ::Any)): add an observation to the
- [`Prometheus.observe`](@ref observe(::Summary, ::Real)): add an observation to the
summary.
- [`Prometheus.@time`](@ref): time a section and add the elapsed time as an observation.
"""

Loading…
Cancel
Save