doc: Add documentation on Producer and remaining modules #149
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
sir4ur0n
commented
Jul 19, 2020
| @@ -159,7 +157,7 @@ pollMessage c@(KafkaConsumer _ (KafkaConf _ qr _)) (Timeout ms) = liftIO $ do | |||
| -- Unlike 'pollMessage' this function does not return usual "timeout" errors. | |||
| -- An empty batch is returned when there are no messages available. | |||
| -- | |||
| -- This API is not available when 'userPolls' is set. | |||
There was a problem hiding this comment.
AFAIU this was a fragment of the past coming from #108
sir4ur0n
force-pushed
the
doc/kafkaProducer
branch
from
2aecb3f to
73d3873
Compare
sir4ur0n
commented
Jul 19, 2020
| data CallbackPollMode = CallbackPollModeSync | CallbackPollModeAsync deriving (Show, Eq) | ||
|
|
||
| -- | Properties to create 'KafkaConsumer'. | ||
| -- | Whether the callback polling should be done synchronously or not. |
There was a problem hiding this comment.
I documented this type to the best of my knowledge, feel free to correct
sir4ur0n
commented
Jul 19, 2020
| | DeliveryFailure ProducerRecord KafkaError | ||
| -- | An error occurred, but /librdkafka/ did not attach any sent message |
There was a problem hiding this comment.
I'm not sure in which scenario this can occur?
|
Thanks! |
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.
Hey, it's been a long time since my previous "documentation" big PR 😄
I finally found the time and motivation today to work on the second part of documentation.
AFAIU (according to Haddock report) the remaining parts that are not documented are:
Kafka.Metadatamodule, for which I have neither the time (right now), the motivation (😁) nor the knowledge to documentThat aside, there is 100% documentation.
I seized the opportunity to cleanup/improve some existing documentation here and there, I will add some ad hoc (ahah) comments in the PR to pinpoint those.
Cheers!