Skip to content

Commit

Permalink
fixing Spec typos (#166)
Browse files Browse the repository at this point in the history
  • Loading branch information
dios-david authored Jan 24, 2025
1 parent d1aad4a commit 962a01a
Show file tree
Hide file tree
Showing 12 changed files with 24 additions and 24 deletions.
4 changes: 2 additions & 2 deletions doc/prometheus_boolean.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ and <code>LabelValues</code>.</td></tr><tr><td valign="top"><a href="#values-2">
Creates a boolean using `Spec`.
If a boolean with the same `Spec` exists returns `false`.

Raises `{missing_metric_spec_key, Key, Spec}` error if required `Soec` key
Raises `{missing_metric_spec_key, Key, Spec}` error if required `Spec` key
is missing.<br />
Raises `{invalid_metric_name, Name, Message}` error if metric `Name`
is invalid.<br />
Expand Down Expand Up @@ -104,7 +104,7 @@ Otherwise returns `{true, _}`.

Creates a boolean using `Spec`.

Raises `{missing_metric_spec_key, Key, Spec}` error if required `Soec` key
Raises `{missing_metric_spec_key, Key, Spec}` error if required `Spec` key
is missing.<br />
Raises `{invalid_metric_name, Name, Message}` error if metric `Name`
is invalid.<br />
Expand Down
4 changes: 2 additions & 2 deletions doc/prometheus_counter.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ and <code>LabelValues</code>.</td></tr><tr><td valign="top"><a href="#values-2">
Creates a counter using `Spec`, if a counter with the same `Spec` exists
returns `false`.

Raises `{missing_metric_spec_key, Key, Spec}` error if required `Soec` key
Raises `{missing_metric_spec_key, Key, Spec}` error if required `Spec` key
is missing.<br />
Raises `{invalid_metric_name, Name, Message}` error if metric `Name`
is invalid.<br />
Expand Down Expand Up @@ -176,7 +176,7 @@ mismatch.

Creates a counter using `Spec`.

Raises `{missing_metric_spec_key, Key, Spec}` error if required `Soec` key
Raises `{missing_metric_spec_key, Key, Spec}` error if required `Spec` key
is missing.<br />
Raises `{invalid_metric_name, Name, Message}` error if metric `Name`
is invalid.<br />
Expand Down
4 changes: 2 additions & 2 deletions doc/prometheus_gauge.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Equivalent to [`inc(Registry, Name, LabelValues, -1 * Value)`](#inc-4).
Creates a gauge using `Spec`.
If a gauge with the same `Spec` exists returns `false`.

Raises `{missing_metric_spec_key, Key, Spec}` error if required `Soec` key
Raises `{missing_metric_spec_key, Key, Spec}` error if required `Spec` key
is missing.<br />
Raises `{invalid_metric_name, Name, Message}` error if metric `Name`
is invalid.<br />
Expand Down Expand Up @@ -208,7 +208,7 @@ mismatch.

Creates a gauge using `Spec`.

Raises `{missing_metric_spec_key, Key, Spec}` error if required `Soec` key
Raises `{missing_metric_spec_key, Key, Spec}` error if required `Spec` key
is missing.<br />
Raises `{invalid_metric_name, Name, Message}` error if metric `Name`
is invalid.<br />
Expand Down
4 changes: 2 additions & 2 deletions doc/prometheus_histogram.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ and `LabelValues`.
Creates a histogram using `Spec`.
If a histogram with the same `Spec` exists returns `false`.

Raises `{missing_metric_spec_key, Key, Spec}` error if required `Soec` key
Raises `{missing_metric_spec_key, Key, Spec}` error if required `Spec` key
is missing.<br />
Raises `{invalid_metric_name, Name, Message}` error if metric `Name`
is invalid.<br />
Expand Down Expand Up @@ -145,7 +145,7 @@ Otherwise returns `{false, _}`.

Creates a histogram using `Spec`.

Raises `{missing_metric_spec_key, Key, Spec}` error if required `Soec` key
Raises `{missing_metric_spec_key, Key, Spec}` error if required `Spec` key
is missing.<br />
Raises `{invalid_metric_name, Name, Message}` error if metric `Name`
is invalid.<br />
Expand Down
4 changes: 2 additions & 2 deletions doc/prometheus_quantile_summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ and <code>LabelValues</code>.</td></tr><tr><td valign="top"><a href="#values-2">
Creates a summary using `Spec`.
If a summary with the same `Spec` exists returns `false`.

Raises `{missing_metric_spec_key, Key, Spec}` error if required `Soec` key
Raises `{missing_metric_spec_key, Key, Spec}` error if required `Spec` key
is missing.<br />
Raises `{invalid_metric_name, Name, Message}` error if metric `Name`
is invalid.<br />
Expand Down Expand Up @@ -109,7 +109,7 @@ Otherwise returns `{false, _}`.

Creates a summary using `Spec`.

Raises `{missing_metric_spec_key, Key, Spec}` error if required `Soec` key
Raises `{missing_metric_spec_key, Key, Spec}` error if required `Spec` key
is missing.<br />
Raises `{invalid_metric_name, Name, Message}` error if metric `Name`
is invalid.<br />
Expand Down
4 changes: 2 additions & 2 deletions doc/prometheus_summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ and <code>LabelValues</code>.</td></tr><tr><td valign="top"><a href="#values-2">
Creates a summary using `Spec`.
If a summary with the same `Spec` exists returns `false`.

Raises `{missing_metric_spec_key, Key, Spec}` error if required `Soec` key
Raises `{missing_metric_spec_key, Key, Spec}` error if required `Spec` key
is missing.<br />
Raises `{invalid_metric_name, Name, Message}` error if metric `Name`
is invalid.<br />
Expand Down Expand Up @@ -102,7 +102,7 @@ Otherwise returns `{false, _}`.

Creates a summary using `Spec`.

Raises `{missing_metric_spec_key, Key, Spec}` error if required `Soec` key
Raises `{missing_metric_spec_key, Key, Spec}` error if required `Spec` key
is missing.<br />
Raises `{invalid_metric_name, Name, Message}` error if metric `Name`
is invalid.<br />
Expand Down
4 changes: 2 additions & 2 deletions src/metrics/prometheus_boolean.erl
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@

%% @doc Creates a boolean using `Spec'.
%%
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Soec' key
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Spec' key
%% is missing.<br/>
%% Raises `{invalid_metric_name, Name, Message}' error if metric `Name'
%% is invalid.<br/>
Expand All @@ -92,7 +92,7 @@ new(Spec) ->
%% @doc Creates a boolean using `Spec'.
%% If a boolean with the same `Spec' exists returns `false'.
%%
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Soec' key
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Spec' key
%% is missing.<br/>
%% Raises `{invalid_metric_name, Name, Message}' error if metric `Name'
%% is invalid.<br/>
Expand Down
4 changes: 2 additions & 2 deletions src/metrics/prometheus_counter.erl
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@

%% @doc Creates a counter using `Spec'.
%%
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Soec' key
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Spec' key
%% is missing.<br/>
%% Raises `{invalid_metric_name, Name, Message}' error if metric `Name'
%% is invalid.<br/>
Expand All @@ -117,7 +117,7 @@ new(Spec) ->
%% @doc Creates a counter using `Spec', if a counter with the same `Spec' exists
%% returns `false'.
%%
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Soec' key
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Spec' key
%% is missing.<br/>
%% Raises `{invalid_metric_name, Name, Message}' error if metric `Name'
%% is invalid.<br/>
Expand Down
4 changes: 2 additions & 2 deletions src/metrics/prometheus_gauge.erl
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@

%% @doc Creates a gauge using `Spec'.
%%
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Soec' key
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Spec' key
%% is missing.<br/>
%% Raises `{invalid_metric_name, Name, Message}' error if metric `Name'
%% is invalid.<br/>
Expand All @@ -121,7 +121,7 @@ new(Spec) ->
%% @doc Creates a gauge using `Spec'.
%% If a gauge with the same `Spec' exists returns `false'.
%%
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Soec' key
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Spec' key
%% is missing.<br/>
%% Raises `{invalid_metric_name, Name, Message}' error if metric `Name'
%% is invalid.<br/>
Expand Down
4 changes: 2 additions & 2 deletions src/metrics/prometheus_histogram.erl
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@

%% @doc Creates a histogram using `Spec'.
%%
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Soec' key
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Spec' key
%% is missing.<br/>
%% Raises `{invalid_metric_name, Name, Message}' error if metric `Name'
%% is invalid.<br/>
Expand Down Expand Up @@ -132,7 +132,7 @@ new(Spec) ->
%% @doc Creates a histogram using `Spec'.
%% If a histogram with the same `Spec' exists returns `false'.
%%
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Soec' key
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Spec' key
%% is missing.<br/>
%% Raises `{invalid_metric_name, Name, Message}' error if metric `Name'
%% is invalid.<br/>
Expand Down
4 changes: 2 additions & 2 deletions src/metrics/prometheus_quantile_summary.erl
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@

%% @doc Creates a summary using `Spec'.
%%
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Soec' key
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Spec' key
%% is missing.<br/>
%% Raises `{invalid_metric_name, Name, Message}' error if metric `Name'
%% is invalid.<br/>
Expand All @@ -107,7 +107,7 @@ new(Spec) ->
%% @doc Creates a summary using `Spec'.
%% If a summary with the same `Spec' exists returns `false'.
%%
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Soec' key
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Spec' key
%% is missing.<br/>
%% Raises `{invalid_metric_name, Name, Message}' error if metric `Name'
%% is invalid.<br/>
Expand Down
4 changes: 2 additions & 2 deletions src/metrics/prometheus_summary.erl
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@

%% @doc Creates a summary using `Spec'.
%%
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Soec' key
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Spec' key
%% is missing.<br/>
%% Raises `{invalid_metric_name, Name, Message}' error if metric `Name'
%% is invalid.<br/>
Expand All @@ -97,7 +97,7 @@ new(Spec) ->
%% @doc Creates a summary using `Spec'.
%% If a summary with the same `Spec' exists returns `false'.
%%
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Soec' key
%% Raises `{missing_metric_spec_key, Key, Spec}' error if required `Spec' key
%% is missing.<br/>
%% Raises `{invalid_metric_name, Name, Message}' error if metric `Name'
%% is invalid.<br/>
Expand Down

0 comments on commit 962a01a

Please sign in to comment.