Update a bunch of docs #654
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
Addresses #653.
|
The only thing I didn't try to address in this PR was goroutines-vs-select for the async producer; neither is wrong or even really preferred, the best advice I have is to go read some tutorials on Go's concurrency model and pick the one that is best for your application :/ (FWIW, most of our internal apps have tended towards goroutines, but I think that's due in big part just to the style that Willem and I established and not to any deliberate choice). |
|
The shitty part about godoc is how it renders documentation (and TOC) for interfaces. Nothing much we can do about it though. |
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.
Hopefully addresses #653.
@wvanbergen @uhoh-itsmaciek