summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Socol <me@jamessocol.com>2014-01-03 01:53:56 -0500
committerJames Socol <me@jamessocol.com>2014-01-03 01:53:56 -0500
commit56e553055e7acb02fcdaeb56b598e5a8cce431b4 (patch)
tree0255a764d838168aaed7a5dfba871d0a65a9efc2
parent7631882319a02981d862fb0620f95ef6bdf805cd (diff)
downloadpystatsd-56e553055e7acb02fcdaeb56b598e5a8cce431b4.tar.gz
Clean up docs examples and references.
-rw-r--r--docs/reference.rst6
-rw-r--r--docs/timing.rst4
2 files changed, 4 insertions, 6 deletions
diff --git a/docs/reference.rst b/docs/reference.rst
index 7490a65..09a390e 100644
--- a/docs/reference.rst
+++ b/docs/reference.rst
@@ -172,8 +172,7 @@ Record :ref:`timer <timer-type>` information.
::
- timer = StatsClient().timer('foo', rate=1).start()
- timer.stop()
+ timer = StatsClient().timer('foo', rate=1)
Automatically record timing information for a managed block or function
call. See also the :ref:`chapter on timing <timing-chapter>`.
@@ -233,8 +232,7 @@ Causes the timer to send any unsent data. If the data has already been
sent, or has not yet been recorded, a ``RuntimeError`` is raised.
.. note::
- See the note abbout `timer objects and pipelines
- <timer-direct-note>`_.
+ See the note abbout :ref:`timer objects and pipelines <timer-direct-note>`.
.. _pipeline:
diff --git a/docs/timing.rst b/docs/timing.rst
index 053749d..da4e241 100644
--- a/docs/timing.rst
+++ b/docs/timing.rst
@@ -71,8 +71,8 @@ be sent to the statsd server.
myfunc(3, 7)
-Using a Timer directly
-======================
+Using a Timer object directly
+=============================
:py:class:`statsd.client.Timer` objects function as context managers and
as decorators, but they can also be used directly. (Flat is, after all,