From 45679bba2d2a147a5863e9d38a66d06b9552a559 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Wed, 12 Jul 2017 13:29:08 +0200 Subject: [PATCH 1/2] Added a tip about the support of microseconds in Stopwatch --- components/stopwatch.rst | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/components/stopwatch.rst b/components/stopwatch.rst index d2791f5bbb5..a04fe743c47 100644 --- a/components/stopwatch.rst +++ b/components/stopwatch.rst @@ -34,13 +34,24 @@ microtime by yourself. Instead, use the simple $event = $stopwatch->stop('eventName'); The :class:`Symfony\\Component\\Stopwatch\\StopwatchEvent` object can be retrieved -from the :method:`Symfony\\Component\\Stopwatch\\Stopwatch::start`, -:method:`Symfony\\Component\\Stopwatch\\Stopwatch::stop`, -:method:`Symfony\\Component\\Stopwatch\\Stopwatch::lap` and -:method:`Symfony\\Component\\Stopwatch\\Stopwatch::getEvent` methods. +from the :method:`Symfony\\Component\\Stopwatch\\Stopwatch::start`, +:method:`Symfony\\Component\\Stopwatch\\Stopwatch::stop`, +:method:`Symfony\\Component\\Stopwatch\\Stopwatch::lap` and +:method:`Symfony\\Component\\Stopwatch\\Stopwatch::getEvent` methods. The latter should be used when you need to retrieve the duration of an event while it is still running. +.. tip:: + + By default, Stopwatch truncates any sub-millisecond time measure to ``0``, + so you can't measure microseconds or nanoseconds. If you need more precision, + pass ``true`` to the ``Stopwatch`` class constructor to enable full precision:: + + $stopwatch = new Stopwatch(true); + + .. versionadded:: 3.4 + The full precision feature was introduced in Symfony 3.4. + You can also provide a category name to an event:: $stopwatch->start('eventName', 'categoryName'); From 24e93f5728de171a2a17f957d445e2795fafb7f7 Mon Sep 17 00:00:00 2001 From: Javier Eguiluz Date: Thu, 13 Jul 2017 08:34:37 +0200 Subject: [PATCH 2/2] Fixed a grammar issue --- components/stopwatch.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/stopwatch.rst b/components/stopwatch.rst index a04fe743c47..27d30cce6db 100644 --- a/components/stopwatch.rst +++ b/components/stopwatch.rst @@ -43,7 +43,7 @@ while it is still running. .. tip:: - By default, Stopwatch truncates any sub-millisecond time measure to ``0``, + By default, the stopwatch truncates any sub-millisecond time measure to ``0``, so you can't measure microseconds or nanoseconds. If you need more precision, pass ``true`` to the ``Stopwatch`` class constructor to enable full precision::