Skip to content

Commit c6f67d6

Browse files
committed
Update README
1 parent 23bb9ed commit c6f67d6

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ScalaNullSafe
22

3-
The purpose of this macro is to provide a quick, easy, readable/writable, and efficient way to make code null-safe in scala.
3+
The purpose of this library is to provide a quick, easy, readable/writable, and efficient way to do null-safe traversals in Scala.
44

55
[![Scala CI](https://github.com/ryanstull/ScalaNullSafe/actions/workflows/test.yml/badge.svg)](https://github.com/ryanstull/ScalaNullSafe/actions/workflows/test.yml)
66

@@ -283,12 +283,12 @@ You can find the source code for the JMH benchmarks [here](https://github.com/ry
283283
compare all of the known ways (or at least the ways that I know of) to handle null-safety in scala.
284284

285285
The reason ScalaNullSafe performs the best is because there are no extraneous method calls, memory allocations, or exception handling, which all of the other solutions use.
286-
By leveraging the power of macros we are able to produce theoretically optimal bytecode, whose performance is equivalent to the explicit null safety approach.
286+
By leveraging the power of macros we are able to produce theoretically-optimal bytecode, whose performance is equivalent to the explicit null safety approach.
287287

288288
## Why?
289289

290290
Some people have questioned the reason for this library's existence since, in Scala, the idiomatic way to handle potentially absent values is to use `Option[A]`.
291-
The reason this library is needed is because there will be situations where you need to extract deeply nested data, in a null-safe way, that was not defined using `Option[A]`.
291+
The reason this library is needed is that there are situations where you need to extract deeply nested data, in a null-safe way, that was not defined using `Option[A]`.
292292
This mostly happens when interoping with Java, but could also occur with any other JVM language. The original reason this library was created was to simplify a large amount of
293293
code that dealt with extracting values out of highly nested [Avro](https://avro.apache.org/) data structures.
294294

0 commit comments

Comments
 (0)