Create doctests for Colog.Core.Action
#61
Conversation
chshersh
added
package:co-log-core
co-log-core/src/Colog/Core/Action.hs
Outdated
| -- | Operator version of 'cmap'. | ||
| {- | Operator version of 'cmap'. | ||
|
|
||
| >>> logString = LogAction putStrLn |
There was a problem hiding this comment.
I think it's better to use logStringStdout from Colog.Core.IO module
There was a problem hiding this comment.
This would require a cyclic dependency, since Core.IO depends on Core.Action. Or are you suggesting to reuse the name from Core.IO for clarity?
There was a problem hiding this comment.
@cronokirby cyclic dependency is not a problem, because doctest has it's own $setup comment to import other modules. See this module in relude for example:
Even if Relude imports Relude.String.Conversion, it's still okay to import Relude in the comments.
| {- | @divide@ combinator from @Divisible@ type class. | ||
|
|
||
| >>> logString = LogAction putStrLn | ||
| >>> logInt = LogAction print |
There was a problem hiding this comment.
Btw, LogAction print looks like a good addition to the Colog.Core.IO module
There was a problem hiding this comment.
Should I go ahead and add this in this pr, or should we open an issue?
There was a problem hiding this comment.
@cronokirby I think separate issue is better 👍
co-log-core/src/Colog/Core/Action.hs
Outdated
| -- | @conquer@ combinator from @Divisible@ type class. | ||
| {- | @conquer@ combinator from @Divisible@ type class. | ||
|
|
||
| Concretely, this is a logAction that does nothing: |
There was a problem hiding this comment.
Instead of logAction it's better to write 'LogAction' to convert it into link
Allows us to reuse functions we provide instead of handwriting them in each example. Requires adding a few lines at the top of the module to setup the import of Core.IO.
Resolves #58.
Expands the documentation for functions, by adding documentation tests.
There were cases in which a function was heavily documented with an example that wasn't tested, e.g.
using a combinator to log both to files and stdout; in those cases I didn't change them. In the cases
where a combinator / function was just a flipped version or synonym of another, I also didn't document any more, as I felt this was redundant.
I also noticed that
conquerhad the same implementation asmempty, so defined the formervia the latter to avoid code duplication.