Document the enums and use them in the examples#2
Merged
Merged
Conversation
The enums shipped in 0.2.0 with no mention in the README, and the config examples still passed bare strings. Every snippet here was compiled or run before landing.
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
1 participant
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.
The enums landed in 0.2.0 with no mention in the README at all, and the configuration examples still passed bare strings. This fixes both.
Every snippet was checked rather than eyeballed: the Go example compiles against the package, the Python one runs, and the TypeScript one typechecks. That caught a real mistake in the first draft, where the Go example used
client, err := epoint.New(...)even thoughNewreturns only*Client.