Added a clarificatory remark and one example to openReplicaSet' #127
Conversation
This file contains hidden or 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
why-not-try-calmer
force-pushed
the
adrien/few-clarifications
branch
from
8027aeb to
2025b56
Compare
| openReplicaSetSRV' :: HostName -> IO ReplicaSet | ||
| -- ^ Open /secure/ connections (on demand) to servers in a replica set. The seedlist and replica set name is fetched from the SRV and TXT DNS records for the given hostname. The value of 'globalConnectTimeout' at the time of this call is the timeout used for future member connect attempts. To use your own value call 'openReplicaSetSRV'''' instead. | ||
| -- The preferred connection method for cloud MongoDB providers. | ||
| -- ==== __Example__ |
Member
There was a problem hiding this comment.
Haddock requires special markers if you are giving a code example: https://haskell-haddock.readthedocs.io/en/latest/markup.html#code-blocks
You can also check what the formatted text looks like if you run
$ cabal haddock
It will tell you where it put generated docs.
Member
|
Could you also please follow commit message guidelines as described here: https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project |
Some new users might be put off by the lack of a array of choice between connection methods that this package offers. This remark and the associated examples are a first attempt to make the package easier to start with. --
why-not-try-calmer
force-pushed
the
adrien/few-clarifications
branch
from
e7849d7 to
6ad28bc
Compare
why-not-try-calmer
changed the title
Contributor
Author
|
Any news from the front? :) |
Member
|
Sorry, I didn't realized that this new commit is different. Just tested it. Looks good. I'll merge this weekend. |
… their use of Pipeline.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Some new users might be put off by the lack of a array of choice between connection methods
that this package offers. This remark and the associated examples are a first attempt to make the package easier to start with.