From 9e5f9c6a2166ff80b41f04bd0e39c4743af3f956 Mon Sep 17 00:00:00 2001 From: Mike Thompson Date: Sat, 20 Jan 2018 17:00:40 +1100 Subject: [PATCH] Docs tweaks --- .../UnderstandingTiming.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/HyperlinkedInformation/UnderstandingTiming.md b/docs/HyperlinkedInformation/UnderstandingTiming.md index 65a72a3..7e31335 100644 --- a/docs/HyperlinkedInformation/UnderstandingTiming.md +++ b/docs/HyperlinkedInformation/UnderstandingTiming.md @@ -1,12 +1,12 @@ -This document explains key aspects of the "Timing" tab. +This document explains useful things about the "Timing" tab. ## First, The Warnings -There are two issues with the numbers you are looking at in the "Timing" tab: +There are two issues with the numbers displayed in the "Timing" tab: 1. Accurately timing something in the browser is almost a fool's errand. One moment it takes 1ms and the next it - takes 10ms, and you’ll never know why. Noisy. + takes 10ms, and you’ll never know why. Noisy. So, do not ever believe one set of timings numbers. @@ -18,9 +18,9 @@ There are two issues with the numbers you are looking at in the "Timing" tab: 2. Don't freak out about any apparent slowness, yet. You're currently running a dev build, right, not the - production build. + production build? And I'm guessing you're also running a dev build - of React. + of React? Also, using `re-frame-trace` will slow things down too, what with all that creating and analysing of trace. @@ -31,14 +31,14 @@ There are two issues with the numbers you are looking at in the "Timing" tab: This Timing panel is not really about absolute numbers so much as the relative time taken to do the "parts" of an Epoch. - And, even then, be careful of these relative numbers because + And, even then, be cautious of these relative numbers because of point 1 (above). ## Know Your Epoch Timeline You'll understand the contents of the Timings tab better if you -understand how an event is processed over time. The following is from -the re-frame project itself. +understand how an event is processed over time within the browser. +The following infographic might help: