Skip to content
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.

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

Documentation fixes #1033

Merged
merged 1 commit into from
Oct 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/cats-mtl-interop.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ for {
}
```

so you have a problem - how we can easy use `extermalProblem`?
Usually programmers write your own implicits conversions, but `TOFU` could provide this instances for you!
so you have a problem - how we can easily use `extermalProblem`?
Usually programmers write your own implicit conversions, but `TOFU` could provide this instance for you!

### Install
For installation interop, add dependency into your project:
Expand Down
5 changes: 2 additions & 3 deletions docs/concurrent-makeref.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,8 @@ object Ref {
}
```

In fact, mutable content modifying is a side effect. Creating of mutable reference itself is a side effect too. Sometime we w
Ref helps to solve by offering some method to create instance which takes one or two type parameters as effect constructors.
Althought, this methods needs to given Sync instances for our effects.
In fact, mutable content modifying is a side effect. Creating of mutable reference itself is a side effect too. Sometimes Ref helps to solve by offering some method to create instance which takes one or two type parameters as effect constructors.
Although, this method needs to be given Sync instances for our effects.

## Tofu: MakeRef

Expand Down
2 changes: 1 addition & 1 deletion docs/tofu.logging.layouts.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Logback Layouts

# Layouts

Tofu is built upon [Logback](http://logback.qos.ch/) so it needs a custom `logback.xml` file with contexual logging
Tofu is built upon [Logback](http://logback.qos.ch/) so it needs a custom `logback.xml` file with contextual logging
support. Tofu uses mechanism called markers to store context in logs, so it won't work with existing Layouts e.g.
with [Logstash-encoder](https://github.com/logstash/logstash-logback-encoder).

Expand Down
2 changes: 1 addition & 1 deletion docs/tofu.logging.loggable.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ There are multiple predefined ways to create an instance of `Loggable`, many of
in `tofu.logging.Loggable` object:

* `Loggable.empty` for no-op logging of value
* `Loggable.show` for using `cats.Show` instance as string representaion
* `Loggable.show` for using `cats.Show` instance as string representation
* `Loggable.either` for logging either of `A` and `B`
* provided instances for all primitive types, as well as stdlib's collections and collections from Cats
* java.time.* instances
Expand Down