Skip to content

Commit 7b3b4b5

Browse files
committed
fix doc typo
1 parent 96e358b commit 7b3b4b5

File tree

3 files changed

+71
-3
lines changed

3 files changed

+71
-3
lines changed

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,41 @@ A counter can simply be incremented by 1 using `metrics:update/1`. or by passing
4343
```
4444
metrics:update("c", {c, 1}).`''
4545
46-
Other metrics are updated via <code>metrics:update/2`.## Example:<pre lang="erlang">1> application:ensure_all_started(metrics).{ok,[metrics]}2> application:ensure_all_started(folsom).{ok,[bear,folsom]}3> metrics:backend(metrics_folsom).ok4> metrics:new(counter, "c").ok5> metrics:update("c").ok6> folsom_metrics:get_metric_value("c").17> metrics:update("c", {c, 1}).ok8> folsom_metrics:get_metric_value("c").2</pre>## DocumentationFull doc is available in the <a href="metrics.html"><code>metrics</code></a> module.## Build```$ rebar3 compile</code>''
46+
Other metrics are updated via `metrics:update/2`.
47+
48+
## Example:
49+
50+
```erlang
51+
52+
1> application:ensure_all_started(metrics).
53+
{ok,[metrics]}
54+
2> application:ensure_all_started(folsom).
55+
{ok,[bear,folsom]}
56+
3> metrics:backend(metrics_folsom).
57+
ok
58+
4> metrics:new(counter, "c").
59+
ok
60+
5> metrics:update("c").
61+
ok
62+
6> folsom_metrics:get_metric_value("c").
63+
1
64+
7> metrics:update("c", {c, 1}).
65+
ok
66+
8> folsom_metrics:get_metric_value("c").
67+
2
68+
69+
```
70+
71+
## Documentation
72+
73+
Full doc is available in the [`metrics`](http://github.com/benoitc/erlang-metrics/blob/master/doc/metrics.md) module.
74+
75+
## Build
76+
77+
```
78+
$ rebar3 compile
79+
```
80+
4781

4882

4983
## Modules ##

doc/README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,41 @@ A counter can simply be incremented by 1 using `metrics:update/1`. or by passing
4343
```
4444
metrics:update("c", {c, 1}).`''
4545
46-
Other metrics are updated via <code>metrics:update/2`.## Example:<pre lang="erlang">1> application:ensure_all_started(metrics).{ok,[metrics]}2> application:ensure_all_started(folsom).{ok,[bear,folsom]}3> metrics:backend(metrics_folsom).ok4> metrics:new(counter, "c").ok5> metrics:update("c").ok6> folsom_metrics:get_metric_value("c").17> metrics:update("c", {c, 1}).ok8> folsom_metrics:get_metric_value("c").2</pre>## DocumentationFull doc is available in the <a href="metrics.html"><code>metrics</code></a> module.## Build```$ rebar3 compile</code>''
46+
Other metrics are updated via `metrics:update/2`.
47+
48+
## Example:
49+
50+
```erlang
51+
52+
1> application:ensure_all_started(metrics).
53+
{ok,[metrics]}
54+
2> application:ensure_all_started(folsom).
55+
{ok,[bear,folsom]}
56+
3> metrics:backend(metrics_folsom).
57+
ok
58+
4> metrics:new(counter, "c").
59+
ok
60+
5> metrics:update("c").
61+
ok
62+
6> folsom_metrics:get_metric_value("c").
63+
1
64+
7> metrics:update("c", {c, 1}).
65+
ok
66+
8> folsom_metrics:get_metric_value("c").
67+
2
68+
69+
```
70+
71+
## Documentation
72+
73+
Full doc is available in the [`metrics`](metrics.md) module.
74+
75+
## Build
76+
77+
```
78+
$ rebar3 compile
79+
```
80+
4781

4882

4983
## Modules ##

doc/overview.edoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ metrics:update("c", {c, 1}).
4444

4545
'''
4646

47-
Other metrics are updated via `metrics:update/2`.
47+
Other metrics are updated via `metrics:update/2'.
4848

4949

5050
## Example:

0 commit comments

Comments
 (0)