From bb3165169c6ed8230f26ae6717d543e6c66c0922 Mon Sep 17 00:00:00 2001 From: Fredrik Ekre Date: Fri, 8 Mar 2024 12:05:20 +0100 Subject: [PATCH] Fix method signatures when including docstrings. --- docs/src/index.md | 12 ++++++------ src/Prometheus.jl | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/src/index.md b/docs/src/index.md index 254ab6e..9a2fd54 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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): ```@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): ```@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): ```@docs Prometheus.Summary(::String, ::String; kwargs...) -Prometheus.observe(::Prometheus.Summary, ::Any) +Prometheus.observe(::Prometheus.Summary, ::Real) ``` ```@docs; canonical=false Prometheus.@time diff --git a/src/Prometheus.jl b/src/Prometheus.jl index 4b9db05..f3ff514 100644 --- a/src/Prometheus.jl +++ b/src/Prometheus.jl @@ -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. 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. """