Skip to content

Commit 7a823fb

Browse files
committed
layout & typos
1 parent 6c624d8 commit 7a823fb

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,10 @@ func CopyFile(src, dst string) (err error) {
6969
All of the listed above **without any performance penalty**! You are welcome to
7070
run `benchmarks` in the project repo and see yourself.
7171

72-
> [!IMPORTANT]
72+
<details>
73+
<summary><b>It's too fast!</b></summary>
74+
<br/>
75+
7376
> Most of the benchmarks run 'too fast' according to the common Go
7477
> benchmarking rules, i.e., compiler optimizations
7578
> ([inlining](https://en.wikipedia.org/wiki/Inline_expansion)) are working so
@@ -78,6 +81,8 @@ run `benchmarks` in the project repo and see yourself.
7881
> The whole package is written toward that goal. Especially with parametric
7982
> polymorphism, it's been quite the effort.
8083
84+
</details>
85+
8186
## Automatic Error Propagation
8287

8388
Automatic error propagation is crucial because it makes your *code change
@@ -218,7 +223,7 @@ error handlers where ever you want in your call stack. That can be handy in the
218223
internal packages and certain types of algorithms.
219224
220225
<details>
221-
<summary>Immediate Error Handling Options</summary>
226+
<summary><b>Immediate Error Handling Options</b></summary>
222227
<br/>
223228
224229
In cases where you want to handle the error immediately after the function call
@@ -305,7 +310,7 @@ development where you set pre- and post-conditions for *all* of your functions,
305310
#### Asserters
306311
307312
<details>
308-
<summary>Fast Clean Code with Asserters</summary>
313+
<summary><b>Fast Clean Code with Asserters</b></summary>
309314
<br/>
310315
311316
Asserts are not meant to replace the normal error checking but speed up the
@@ -365,7 +370,6 @@ boundaries.
365370
<details>
366371
<summary>The unit test code example:</summary>
367372
368-
369373
```go
370374
func TestWebOfTrustInfo(t *testing.T) {
371375
defer assert.PushTester(t)()
@@ -418,7 +422,7 @@ You can deploy your applications and services with the simple *end-user friendly
418422
error messages and no stack traces.*
419423
420424
<details>
421-
<summary>You can switch them on when ever you need them again.</summary>
425+
<summary>You can switch them on whenever you need them again.</summary>
422426
<br/>
423427
424428
Let's say you have build CLI (`your-app`) tool with the support for Go's flag
@@ -504,11 +508,12 @@ Flags:
504508
## Code Snippets
505509
506510
<details>
507-
<summary>Most of the repetitive code blocks are offered as code snippets.</summary>
511+
<summary>Code snippets as learning helpers.</summary>
508512
<br/>
509513
510-
They are in `./snippets` in VC code format, which is well supported e.g. neovim,
511-
etc.
514+
The snippets are in `./snippets` and in VC code format, which is well supported
515+
e.g. neovim, etc. They are proven to be useful tool especially when you are
516+
starting to use the err2 and its sub-packages.
512517
513518
The snippets must be installed manually to your preferred IDE/editor. During the
514519
installation you can modify the according your style or add new ones. We would

0 commit comments

Comments
 (0)