Skip to content

Commit e3c9ed4

Browse files
committed
Added TODO and REVIEW markers
1 parent 0b03340 commit e3c9ed4

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

go/learn_go.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,12 @@ Actually tools like `golint` will help you out with this automatically, but let
5353

5454
**Line 6**: This is function declaration
5555

56+
TODO: Add note on main function
57+
5658
The `main` function, is indication of where there executable should start.
5759

60+
TODO: Add notes on function signatures
61+
5862
No parameters:
5963

6064
```go
@@ -87,6 +91,8 @@ So lets add some tests, so make sure our "hello world" implementation works as e
8791

8892
This requires that we dwelve into Go modules and Go testing.
8993

94+
TODO: Add notes on testing in Go
95+
9096
Now that you somewhat up and running with Go, some next steps could be:
9197

9298
- Check out a proposal for a [Go Developer Roadmap][godevroadmap2020] for learning Go in 2020

go/reading_benchmark_results.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ _NB: I have condensed the output a bit for readability, by collapsing excessive
2020

2121
It does require that the test suite has a benchmarking function.
2222

23+
TODO: Add details on benchmarking test
24+
2325
This runs our test suite and benchmarks it, with 3 iterations, specified by the `-count` parameter.
2426

2527
As you can read from the example output.
@@ -61,6 +63,8 @@ _Since I was unable to understand the output, I had to ask around and I received
6163
6264
The first 3 columns are the ones from the basic benchmark. So with the `--benchmem` flag, two more columns are added:
6365

66+
REVIEW: is this description correct?
67+
6468
- Fourth column is the number of _extra_ bytes allocated per iteration
6569
- Fifth column is the number of _extra_ allocations made per iteration
6670

0 commit comments

Comments
 (0)