-
-
Notifications
You must be signed in to change notification settings - Fork 79
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 examples #197
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks really nice! 👍
src/Relude/Extra/Map.hs
Outdated
@@ -121,19 +121,45 @@ instance StaticMap IntSet where | |||
{-# INLINE lookup #-} | |||
{-# INLINE member #-} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we refactor this so that each INLINE
would go under the function?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea!
src/Relude/Lifted/IORef.hs
Outdated
@@ -8,6 +8,9 @@ License: MIT | |||
Maintainer: Kowainik <xrom.xkov@gmail.com> | |||
|
|||
Lifted reexports from 'Data.IORef' module. | |||
|
|||
Lifted meaning that you can also use them inside various |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's keep this comment consistent with other identical comments 🙂
hello | ||
|
||
"hello | ||
hello" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I ended up leaving the "
out because in ghci terminal they're not displayed. ¯_(ツ)_/¯
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe this is some strange behaviour of doctest
@@ -26,6 +26,10 @@ import Relude.Monad (MonadIO, liftIO, (<$!>)) | |||
|
|||
import qualified Control.Exception.Base (evaluate) | |||
|
|||
|
|||
-- $setup | |||
-- >>> import Relude |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I couldn't get import Relude
to work, would always get:
<no location info>: error:
Could not load module ‘Relude’
It is a member of the hidden package ‘relude-0.6.0.0’.
You can run ‘:set -package relude’ to expose it.
(Note: this unloads all the modules in the current scope.)
then follow those instructions and I'd get:
<interactive>:1:1: error:
attempting to use module ‘main:Relude’ (/Users/cmdv/Haskell-OSS/relude/src/Relude.hs) which is not loaded
maybe I have things set up wrong 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I can see that it's possible to have invalid config and break doctest
...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah not too sure, need to look into it. sorry this was off topic but the PR looks great 🎉
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great!
Resolves #173
Now all tests are passing (at least on GHC-8.6.5, let's see what's CI will tell).