Skip to content

Commit 56c304d

Browse files
authored
Highlight color Coding section in README (#221)
This seemed kind of buried, so add a header and some formatting to make it more obvious.
1 parent 0f8565c commit 56c304d

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,10 @@ things about this function:
103103
- `mapslices(sum, A; dims=2)` is considerably more expensive (the corresponding bar is horizontally wider) than
104104
`mapslices(sort, B; dims=1)`. This is because it has to process more
105105
data.
106+
107+
## Color Coding
106108

107-
It is also worth noting that red is (by default) a special color: it is reserved for function
109+
- **Red**: is reserved for function
108110
calls that have to be resolved at run-time.
109111
Because run-time dispatch (aka, dynamic dispatch, run-time method lookup, or
110112
a virtual call) often has a significant
@@ -123,7 +125,7 @@ contribution to its total run time.
123125
See [Solving type-inference problems](solving-type-inference-problems) below
124126
for tips on how to efficiently diagnose the nature of the problem.
125127

126-
Yellow is also a special color: it indicates a site of garbage collection, which can be
128+
- **Yellow**: indicates a site of garbage collection, which can be
127129
triggered at a site of memory allocation. You may find that such bars lead you to lines
128130
whose performance can be improved by reducing the amount of temporary memory allocated
129131
by your program. One common example is to consider using `@views(A[:, i] .* v)` instead

0 commit comments

Comments
 (0)