quick docs fix to the zap example#311
Open
konradjniemiec wants to merge 1 commit into
Open
Conversation
This example doesn't compile—I get: `missing dataset name` Signed-off-by: Konrad Niemiec <42159882+konradjniemiec@users.noreply.github.com>
Collaborator
|
Hi @konradjniemiec 👋 Thanks for the contribution! What you're describing is actually explained a couple of lines before: https://github.com/axiomhq/axiom-go/pull/311/files#diff-65932b4d21b82ce597f2aa3c53c235560d9da11836ed720eb5ca8355d4678859R23-R25. Do you think this is not very obvious and we should improve it? Like do just one code block or something similar? What about other code examples like the ones in examples or GoDoc? |
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
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.
This example doesn't compile—I get:
missing dataset name