Docs tweaks
This commit is contained in:
parent
3a7b5b9c0e
commit
9e5f9c6a21
|
@ -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
|
## 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
|
1. Accurately timing something in the browser is almost
|
||||||
a fool's errand. One moment it takes 1ms and the next it
|
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.
|
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.
|
2. Don't freak out about any apparent slowness, yet.
|
||||||
|
|
||||||
You're currently running a dev build, right, not the
|
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
|
And I'm guessing you're also running a dev build
|
||||||
of React.
|
of React?
|
||||||
|
|
||||||
Also, using `re-frame-trace` will slow things
|
Also, using `re-frame-trace` will slow things
|
||||||
down too, what with all that creating and analysing of trace.
|
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
|
This Timing panel is not really about absolute numbers so
|
||||||
much as the relative time taken to do the "parts" of an Epoch.
|
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).
|
of point 1 (above).
|
||||||
|
|
||||||
## Know Your Epoch Timeline
|
## Know Your Epoch Timeline
|
||||||
|
|
||||||
You'll understand the contents of the Timings tab better if you
|
You'll understand the contents of the Timings tab better if you
|
||||||
understand how an event is processed over time. The following is from
|
understand how an event is processed over time within the browser.
|
||||||
the re-frame project itself.
|
The following infographic might help:
|
||||||
|
|
||||||
<img src="https://raw.githubusercontent.com/Day8/re-frame/master/images/epoch.png">
|
<img src="https://raw.githubusercontent.com/Day8/re-frame/master/images/epoch.png">
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue