docs: Explain Frame.Module and Frame.Package #385
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
rhcarvalho
force-pushed
the
docs-frame-module-package
branch
from
eaa8632
to
89b979b
Compare
iker-barriocanal
approved these changes
Oct 11, 2021
Comment on lines
+163
to
+167
| Function string `json:"function,omitempty"` | ||
| Symbol string `json:"symbol,omitempty"` | ||
| // Module is, despite the name, the Sentry protocol equivalent of a Go | ||
| // package's import path. | ||
| Module string `json:"module,omitempty"` |
There was a problem hiding this comment.
Can we keep the same formatting? See the types of the items below.
There was a problem hiding this comment.
Go code is formatted in a standard way with a tool, gofmt. This is the output of the tool.
The tool aligns fieldname-type-structtag for contiguous blocks of fields, that's what you see below and before adding the documentation.
"Documented" fields lead to no block alignment, for example see this in the Go standard library:
https://cs.opensource.google/go/go/+/refs/tags/go1.17.2:src/net/http/request.go;l=97-324
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.
The naming can be confusing since "Go Package" and "Go Module" have a very specific meaning in Go, but that meaning doesn't match the platform-agnostic meaning from the Sentry protocol.
See also #377 (comment).