Repository navigation
Module readmes - #2
Merged
Merged
Conversation
Describe the global and the scoped closer, the close context semantics and the error handling. Add doc comments to the exported API and to the non-obvious parts of the implementation.
Describe how the unique context keys are created, how they behave and what advantages they give over a hand-written key type. Add doc comments to the exported API.
Describe how the close error is joined with the deferred one and when it is discarded. Add a package doc comment.
Describe how the prototypes are built and used, what errors are returned and when the message is partially filled.
Describe the detection rules, the conversion table and the abbreviation handling. Add doc comments to the exported API and to the conversion helpers.
Describe the retry-until-success semantics of SuccessfulOnce and how it differs from sync.Once. Add doc comments to the exported API.
Describe how the duration is serialized and which values are accepted by the JSON and the YAML decoders. Add doc comments to the exported API.
Add doc comments to the public types and interfaces, and to the trie implementation: the modes, the constructor options and the registration methods.
List every module of the repository with a link and a short description.
The YAML decoder decodes a whole number as an int, so it was rejected before. Now both decoders accept the numbers, and the error of an invalid value mentions its type. Update the README and add the tests for the values that are neither a number nor a valid duration string.
Do not call the package a single helper one: it is going to grow.
Describe the package as a collection of the helpers for the defer calls and move the description of Close into its own section. Drop the package doc comment: the README covers the package better.
The error is only a signal: the dispatch never reports it, it reports the Inner error in its place, and nothing at all when the Inner error is nil. Fix the wording of the README accordingly.
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
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.
No description provided.