Skip to content

Fix potential typos #803

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sirthias merged 2 commits into from
Jan 12, 2026
Merged

Fix potential typos #803

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca91fb9
fix typo in borer-compat-cats.md?
matsluni Jan 12, 2026
b7d05bc
Fix potential typo in CatsCompatSpec.scala?
matsluni Jan 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion site/src/main/paradox/borer-compat-cats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ types, for which there is no clear default encoding:
- `Ior[A, B]`
- `Validated[A, B]`

The encodings implemented by `borer-compat-circe` aim for best time and space efficiency, not "readability".
The encodings implemented by `borer-compat-cats` aim for best time and space efficiency, not "readability".

One easy way to optimize for self-describability rather than efficiency would be to rely on `borer-derivation` instead.
Here is an example contrasting the difference:
Expand Down
2 changes: 1 addition & 1 deletion site/src/test/scala/io/bullet/borer/site/CatsCompatSpec.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class CatsCompatSpec extends BorerSuite {
Ior.Both(42, "bar")
)

// the Ior encoding of `borer-compat-circe` is optimized for efficiency
// the Ior encoding of `borer-compat-cats` is optimized for efficiency
{
import io.bullet.borer.compat.cats.*

Expand Down
Loading