Skip to content

Commit 12184b4

Browse files
authored
docs: Correct heading levels for Data Types sections (#488)
Hello, This is my first contribution to this project. I noticed some inconsistencies in the documentation's heading levels under the Data Types section and decided to fix them. Specifically, the headings for 'Maybe: Allocation-free Optional Values' and 'Result: Low-allocation Try Alternative' were updated from '##' to '###'. This change ensures a uniform structure and improves the readability of the documentation. No functional changes were made to the codebase. Thank you for considering this pull request.
1 parent a68a424 commit 12184b4

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2097,7 +2097,7 @@ val h: Unit < IOs =
20972097

20982098
## Data Types
20992099

2100-
## Maybe: Allocation-free Optional Values
2100+
### Maybe: Allocation-free Optional Values
21012101

21022102
`Maybe` provides an allocation-free alternative to Scala's standard `Option` type. It is designed to be a drop-in replacement for `Option`, offering similar functionality while minimizing memory allocation.
21032103

@@ -2173,7 +2173,7 @@ val nested: Maybe[Maybe[Int]] = Maybe(Maybe(42))
21732173
val flattened: Maybe[Int] = nested.flatten
21742174
```
21752175

2176-
## Result: Low-allocation Try Alternative
2176+
### Result: Low-allocation Try Alternative
21772177

21782178
`Result` is a low-allocation alternative to Scala's `Try` type, designed to represent the result of a computation that may either succeed with a value or fail with an exception. It minimizes memory allocation overhead, especially in the case of successful results.
21792179

0 commit comments

Comments
 (0)