New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
go/doc/comment: doc links don't work for struct field doc #56004
Labels
NeedsInvestigation
Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Milestone
Comments
what are |
Struct types in package scope. package ebnf // import "."
type Identifier struct {
Text string
}
type Literal struct {
Text string
} |
See https://pkg.go.dev/github.com/willfaught/ebnf@v0.4.1#FirstFollowConflictError for the full context, although the brackets are omitted there since it doesn't work. |
cagedmantis
added
the
NeedsInvestigation
Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
label
Oct 7, 2022
cc @griesemer |
See also #59728. |
hacdias
added a commit
to ipfs/boxo
that referenced
this issue
Jun 5, 2023
- Rename BlocksGateway to BlocksBackend (it is an IPFSBackend) - Rename Specification to GatewaySpecification (clarity) - Improve a lot of comments that are visible through pkg.go.dev - Preview with `go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsit` - Note that there's a bug that makes the comments in the struct fields not formatted golang/go#56004 - Unexport `ServeContent` (this was never meant to be public) - Remove `webRequestError` function (`webError`) already handles `ErrorStatusCode` type. Behaviour already existing. Added test to ensure. - Removed return type from functions that _always_ returned nil. - Exported `DagScopeEntity`, `DagScopeAll`, `DagScopeBlock` as they are `DagScope` - Renamed `ErrorResponse` to `ErrorStatusCode` (clarity) - Change some usages of global `log` variable to request-scoped `logger` for more context
hacdias
added a commit
to ipfs/boxo
that referenced
this issue
Jun 5, 2023
- Rename BlocksGateway to BlocksBackend (it is an IPFSBackend) - Rename Specification to GatewaySpecification (clarity) - Improve a lot of comments that are visible through pkg.go.dev - Preview with `go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsit` - Note that there's a bug that makes the comments in the struct fields not formatted golang/go#56004 - Unexport `ServeContent` (this was never meant to be public) - Remove `webRequestError` function (`webError`) already handles `ErrorStatusCode` type. Behaviour already existing. Added test to ensure. - Removed return type from functions that _always_ returned nil. - Exported `DagScopeEntity`, `DagScopeAll`, `DagScopeBlock` as they are `DagScope` - Renamed `ErrorResponse` to `ErrorStatusCode` (clarity) - Change some usages of global `log` variable to request-scoped `logger` for more context
hacdias
added a commit
to ipfs/boxo
that referenced
this issue
Jun 5, 2023
- Rename BlocksGateway to BlocksBackend (it is an IPFSBackend) - Rename Specification to GatewaySpecification (clarity) - Improve a lot of comments that are visible through pkg.go.dev - Preview with `go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsit` - Note that there's a bug that makes the comments in the struct fields not formatted golang/go#56004 - Unexport `ServeContent` (this was never meant to be public) - Remove `webRequestError` function (`webError`) already handles `ErrorStatusCode` type. Behaviour already existing. Added test to ensure. - Removed return type from functions that _always_ returned nil. - Exported `DagScopeEntity`, `DagScopeAll`, `DagScopeBlock` as they are `DagScope` - Renamed `ErrorResponse` to `ErrorStatusCode` (clarity) - Change some usages of global `log` variable to request-scoped `logger` for more context
hacdias
added a commit
to ipfs/boxo
that referenced
this issue
Jun 5, 2023
- Improve documentation of public API that to conform with pkg.go.dev stylings. Can be previewed with: `go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsite` Note that there's a bug that makes the comments in struct fields not formatted: golang/go#56004 - Renamed a few things for consistency and clarity: - `BlocksGateway` to `BlocksBackend` (it is an `IPFSBackend`) - `api` to `backend` (it is an `IPFSBackend`) - `WithHostname` to `NewHostnameHandler` - `Specification` to `PublicGateway` - `ErrorResponse` to `ErrorStatusCode` - Unexported `ServeContent`, which was never meant to be public - Removed `webRequestError`, which is already handled by `webError`. Added a test to ensure that is the case. - Removed return types from functions that always returned nil. - Exported `DagScopeEntity`, `DagScopeAll`, `DagScopeBlock` as they are `DagScope` - Change some usages of global `log` variable to request-scoped `logger` for more context
hacdias
added a commit
to ipfs/boxo
that referenced
this issue
Jun 5, 2023
- Improve documentation of public API that to conform with pkg.go.dev stylings. Can be previewed with: `go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsite` Note that there's a bug that makes the comments in struct fields not formatted: golang/go#56004 - Renamed a few things for consistency and clarity: - `BlocksGateway` to `BlocksBackend` (it is an `IPFSBackend`) - `api` to `backend` (it is an `IPFSBackend`) - `WithHostname` to `NewHostnameHandler` - `Specification` to `PublicGateway` - `ErrorResponse` to `ErrorStatusCode` - Unexported `ServeContent`, which was never meant to be public - Removed `webRequestError`, which is already handled by `webError`. Added a test to ensure that is the case. - Removed return types from functions that always returned nil. - Exported `DagScopeEntity`, `DagScopeAll`, `DagScopeBlock` as they are `DagScope` - Change some usages of global `log` variable to request-scoped `logger` for more context
hacdias
added a commit
to ipfs/boxo
that referenced
this issue
Jun 5, 2023
- Improve documentation of public API that to conform with pkg.go.dev stylings. Can be previewed with: `go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsite` Note that there's a bug that makes the comments in struct fields not formatted: golang/go#56004 - Renamed a few things for consistency and clarity: - `BlocksGateway` to `BlocksBackend` (it is an `IPFSBackend`) - `api` to `backend` (it is an `IPFSBackend`) - `WithHostname` to `NewHostnameHandler` - `Specification` to `PublicGateway` - `ErrorResponse` to `ErrorStatusCode` - Unexported `ServeContent`, which was never meant to be public - Removed `webRequestError`, which is already handled by `webError`. Added a test to ensure that is the case. - Removed return types from functions that always returned nil. - Exported `DagScopeEntity`, `DagScopeAll`, `DagScopeBlock` as they are `DagScope` - Change some usages of global `log` variable to request-scoped `logger` for more context - Handle CAR before maybe resolving path (CAR handles it differently) - Response formats as constants (avoids typos, etc)
hacdias
added a commit
to ipfs/boxo
that referenced
this issue
Jun 5, 2023
- Improve documentation of public API that to conform with pkg.go.dev stylings. Can be previewed with: `go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsite` Note that there's a bug that makes the comments in struct fields not formatted: golang/go#56004 - Renamed a few things for consistency and clarity: - `BlocksGateway` to `BlocksBackend` (it is an `IPFSBackend`) - `api` to `backend` (it is an `IPFSBackend`) - `WithHostname` to `NewHostnameHandler` - `Specification` to `PublicGateway` - `ErrorResponse` to `ErrorStatusCode` - `DagEntityByteRange` to `DagByteRange` (there isn't other) - Unexported `ServeContent`, which was never meant to be public - Removed `webRequestError`, which is already handled by `webError`. Added a test to ensure that is the case. - Removed return types from functions that always returned nil. - Exported `DagScopeEntity`, `DagScopeAll`, `DagScopeBlock` as they are `DagScope` - Change some usages of global `log` variable to request-scoped `logger` for more context - Handle CAR before maybe resolving path (CAR handles it differently) - Response formats as constants (avoids typos, etc)
hacdias
added a commit
to ipfs/boxo
that referenced
this issue
Jun 5, 2023
- Improve documentation of public API that to conform with pkg.go.dev stylings. Can be previewed with: `go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsite` Note that there's a bug that makes the comments in struct fields not formatted: golang/go#56004 - Renamed a few things for consistency and clarity: - `BlocksGateway` to `BlocksBackend` (it is an `IPFSBackend`) - `api` to `backend` (it is an `IPFSBackend`) - `WithHostname` to `NewHostnameHandler` - `Specification` to `PublicGateway` - `ErrorResponse` to `ErrorStatusCode` - `DagEntityByteRange` to `DagByteRange` (there isn't other) - Unexported `ServeContent`, which was never meant to be public - Removed `webRequestError`, which is already handled by `webError`. Added a test to ensure that is the case. - Removed return types from functions that always returned nil. - Exported `DagScopeEntity`, `DagScopeAll`, `DagScopeBlock` as they are `DagScope` - Change some usages of global `log` variable to request-scoped `logger` for more context - Handle CAR before maybe resolving path (CAR handles it differently) - Response formats as constants (avoids typos, etc)
hacdias
added a commit
to ipfs/boxo
that referenced
this issue
Jun 8, 2023
- Improve documentation of public API that to conform with pkg.go.dev stylings. Can be previewed with: `go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsite` Note that there's a bug that makes the comments in struct fields not formatted: golang/go#56004 - Renamed a few things for consistency and clarity: - `BlocksGateway` to `BlocksBackend` (it is an `IPFSBackend`) - `api` to `backend` (it is an `IPFSBackend`) - `WithHostname` to `NewHostnameHandler` - `Specification` to `PublicGateway` - `ErrorResponse` to `ErrorStatusCode` - `DagEntityByteRange` to `DagByteRange` (there isn't other) - Unexported `ServeContent`, which was never meant to be public - Removed `webRequestError`, which is already handled by `webError`. Added a test to ensure that is the case. - Removed return types from functions that always returned nil. - Exported `DagScopeEntity`, `DagScopeAll`, `DagScopeBlock` as they are `DagScope` - Change some usages of global `log` variable to request-scoped `logger` for more context - Handle CAR before maybe resolving path (CAR handles it differently) - Response formats as constants (avoids typos, etc)
hacdias
added a commit
to ipfs/boxo
that referenced
this issue
Jun 8, 2023
- Improve documentation of public API that to conform with pkg.go.dev stylings. Can be previewed with: `go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsite` Note that there's a bug that makes the comments in struct fields not formatted: golang/go#56004 - Renamed a few things for consistency and clarity: - `BlocksGateway` to `BlocksBackend` (it is an `IPFSBackend`) - `api` to `backend` (it is an `IPFSBackend`) - `WithHostname` to `NewHostnameHandler` - `Specification` to `PublicGateway` - `ErrorResponse` to `ErrorStatusCode` - `DagEntityByteRange` to `DagByteRange` (there isn't other) - Unexported `ServeContent`, which was never meant to be public - Removed `webRequestError`, which is already handled by `webError`. Added a test to ensure that is the case. - Removed return types from functions that always returned nil. - Exported `DagScopeEntity`, `DagScopeAll`, `DagScopeBlock` as they are `DagScope` - Change some usages of global `log` variable to request-scoped `logger` for more context - Handle CAR before maybe resolving path (CAR handles it differently) - Response formats as constants (avoids typos, etc)
hacdias
added a commit
to ipfs/boxo
that referenced
this issue
Jun 8, 2023
- Improve documentation of public API that to conform with pkg.go.dev stylings. Can be previewed with: `go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsite` Note that there's a bug that makes the comments in struct fields not formatted: golang/go#56004 - Renamed a few things for consistency and clarity: - `BlocksGateway` to `BlocksBackend` (it is an `IPFSBackend`) - `api` to `backend` (it is an `IPFSBackend`) - `WithHostname` to `NewHostnameHandler` - `Specification` to `PublicGateway` - `ErrorResponse` to `ErrorStatusCode` - `DagEntityByteRange` to `DagByteRange` (there isn't other) - Unexported `ServeContent`, which was never meant to be public - Removed `webRequestError`, which is already handled by `webError`. Added a test to ensure that is the case. - Removed return types from functions that always returned nil. - Exported `DagScopeEntity`, `DagScopeAll`, `DagScopeBlock` as they are `DagScope` - Change some usages of global `log` variable to request-scoped `logger` for more context - Handle CAR before maybe resolving path (CAR handles it differently) - Response formats as constants (avoids typos, etc)
hacdias
added a commit
to ipfs/boxo
that referenced
this issue
Jun 8, 2023
- Improve documentation of public API that to conform with pkg.go.dev stylings. Can be previewed with: `go install golang.org/x/pkgsite/cmd/pkgsite@latest && pkgsite` Note that there's a bug that makes the comments in struct fields not formatted: golang/go#56004 - Renamed a few things for consistency and clarity: - `BlocksGateway` to `BlocksBackend` (it is an `IPFSBackend`) - `api` to `backend` (it is an `IPFSBackend`) - `WithHostname` to `NewHostnameHandler` - `Specification` to `PublicGateway` - `ErrorResponse` to `ErrorStatusCode` - `DagEntityByteRange` to `DagByteRange` (there isn't other) - Unexported `ServeContent`, which was never meant to be public - Removed `webRequestError`, which is already handled by `webError`. Added a test to ensure that is the case. - Removed return types from functions that always returned nil. - Exported `DagScopeEntity`, `DagScopeAll`, `DagScopeBlock` as they are `DagScope` - Change some usages of global `log` variable to request-scoped `logger` for more context - Handle CAR before maybe resolving path (CAR handles it differently) - Response formats as constants (avoids typos, etc)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
NeedsInvestigation
Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
What version of Go are you using (
go version
)?Does this issue reproduce with the latest release?
Yes
What operating system and processor architecture are you using (
go env
)?go env
OutputWhat did you do?
What did you expect to see?
What did you see instead?
Note the square brackets around Identifier and Literal above and to the side of the Terminal field. They aren't being parsed and rendered as doc links. The brackets disappear if put above the type declaration, as expected.
The text was updated successfully, but these errors were encountered: