Writer and WriterT documentation site pages #3618
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #3618 +/- ##
==========================================
- Coverage 91.33% 91.27% -0.06%
==========================================
Files 386 380 -6
Lines 8628 8331 -297
Branches 260 225 -35
==========================================
- Hits 7880 7604 -276
+ Misses 748 727 -21 |
larsrh
suggested changes
Oct 10, 2020
| --- | ||
| # Writer | ||
|
|
||
| The `Writer[L, A]` datatype represents a computation that produce a |
There was a problem hiding this comment.
Suggested change
| The `Writer[L, A]` datatype represents a computation that produce a | |
| The `Writer[L, A]` datatype represents a computation that produces a |
| datatype. Meanwhile, the value `A` is the actual output of the | ||
| computation. | ||
|
|
||
| The main features the `Writer` provides are: |
There was a problem hiding this comment.
Suggested change
| The main features the `Writer` provides are: | |
| The main features that `Writer` provides are: |
| - The flexibility regarding Log value management. It can be modified | ||
| in multiple ways. See the [Operations section](#operations) | ||
| - When two functions are composed together, eg using `flatMap`, the | ||
| logs of both functions will be combined using an implicit [Semigroup](https://typelevel.org/cats/typeclasses/semigroup.html). |
There was a problem hiding this comment.
Both are good points, but if it's an enumeration, the structure of the sentences should be similar. I suggest removing the bullet points and rephrasing it as a paragraph.
|
|
||
| ## Operations | ||
|
|
||
| The `Writer` datatype provides a set of functions that are quite |
There was a problem hiding this comment.
"quite identical" → "similar to"
|
|
||
| The `Writer` datatype provides a set of functions that are quite | ||
| identical to the ones from the [Monad](https://typelevel.org/cats/typeclasses/monad.html) typeclass. In fact, they share | ||
| the same name and the same signature, but for the requirement of a |
There was a problem hiding this comment.
Suggested change
| the same name and the same signature, but for the requirement of a | |
| the same name and the same signature, but have an additional requirement of a |
| ## Composition | ||
|
|
||
| `WriterT` can be more convenient to work with than using | ||
| `F[Writer[L, V]]` directly, this because it exposes operations that allow |
There was a problem hiding this comment.
Suggested change
| `F[Writer[L, V]]` directly, this because it exposes operations that allow | |
| `F[Writer[L, V]]` directly, because it exposes operations that allow |
| Just for completeness, we can have a look at the same example, but | ||
| with | ||
| [`Validated`](https://typelevel.org/cats/datatypes/validated.html) | ||
| since it as a slightly different behaviour then |
There was a problem hiding this comment.
Suggested change
| since it as a slightly different behaviour then | |
| since it as a slightly different behaviour than |
|
|
||
| ## Construct a WriterT | ||
|
|
||
| A `WriterT` can be built starting from multiple values. Here is the |
There was a problem hiding this comment.
Suggested change
| A `WriterT` can be built starting from multiple values. Here is the | |
| A `WriterT` can be constructed in different ways. Here is the |
|
|
||
| ## Operations | ||
|
|
||
| Into the [Writer |
There was a problem hiding this comment.
Suggested change
| Into the [Writer | |
| In the [Writer |
|
|
||
| ## Example | ||
|
|
||
| As en example, we can consider a simple naive console application that |
There was a problem hiding this comment.
Suggested change
| As en example, we can consider a simple naive console application that | |
| As an example, we can consider a simple naive console application that |
Codecov Report
@@ Coverage Diff @@
## master #3618 +/- ##
==========================================
- Coverage 91.33% 91.27% -0.06%
==========================================
Files 386 380 -6
Lines 8628 8331 -297
Branches 260 225 -35
==========================================
- Hits 7880 7604 -276
+ Misses 748 727 -21 |
Codecov Report
@@ Coverage Diff @@
## master #3618 +/- ##
==========================================
- Coverage 91.33% 90.28% -1.05%
==========================================
Files 386 391 +5
Lines 8628 8872 +244
Branches 260 262 +2
==========================================
+ Hits 7880 8010 +130
- Misses 748 862 +114 |
1 similar comment
Codecov Report
@@ Coverage Diff @@
## master #3618 +/- ##
==========================================
- Coverage 91.33% 90.28% -1.05%
==========================================
Files 386 391 +5
Lines 8628 8872 +244
Branches 260 262 +2
==========================================
+ Hits 7880 8010 +130
- Misses 748 862 +114 |
Comments addressed 👍 Thank you |
larsrh
approved these changes
Oct 12, 2020
LukaJCB
approved these changes
Oct 12, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #625
Please be patient, I'm a non native english speaker. Basically the less qualified man for the job. Any feedback appreciated and I'll fix it ASAP