util/interval: update doc.go for bazel#118491
Conversation
|
It looks like your PR touches production code but doesn't add or edit any test code. Did you consider adding tests to your PR? Thank you for contributing to CockroachDB. Please ensure you have followed the guidelines for creating a PR. My owl senses detect your PR is good for review. Please keep an eye out for any test failures in CI. I was unable to automatically find a reviewer. You can try CCing one of the following members:
🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf. |
|
This change is |
|
@nvanbenschoten maybe you're interested in this one. |
pkg/util/interval/generic/doc.go
Outdated
| 3. Include a go generate declaration that invokes the gen.sh script with the | ||
| type name as the first argument and the package name as the second argument. | ||
| 4. Invoke go generate. | ||
| This is done for documentation purposes and will require a corresponding entry |
There was a problem hiding this comment.
TBH I'm not 100% certain why we do this; I'm just documenting the procedure as I understand it.
There was a problem hiding this comment.
The go:generate stanzas are generally "legacy" bits of code. Generally the go:generate pre-dated the existence of the Bazel code generation. There isn't an expectation that one be added assuming you are writing new code.
|
@rickystewart maybe you'll like this one too? Feel free to bors it if you like it. |
pkg/util/interval/generic/doc.go
Outdated
| 3. Include a go generate declaration that invokes the gen.sh script with the | ||
| type name as the first argument and the package name as the second argument. | ||
| 4. Invoke go generate. | ||
| This is done for documentation purposes and will require a corresponding entry |
There was a problem hiding this comment.
The go:generate stanzas are generally "legacy" bits of code. Generally the go:generate pre-dated the existence of the Bazel code generation. There isn't an expectation that one be added assuming you are writing new code.
Relates to cockroachdb#118490. Epic: None Release note: None
324dc3a to
8228707
Compare
|
It looks like your PR touches production code but doesn't add or edit any test code. Did you consider adding tests to your PR? Thank you for updating your pull request. My owl senses detect your PR is good for review. Please keep an eye out for any test failures in CI. 🦉 Hoot! I am a Blathers, a bot for CockroachDB. My owner is dev-inf. |
ajwerner
left a comment
There was a problem hiding this comment.
Reviewable status:
complete! 0 of 0 LGTMs obtained (waiting on @rickystewart)
pkg/util/interval/generic/doc.go line 27 at r1 (raw file):
Previously, rickystewart (Ricky Stewart) wrote…
The
go:generatestanzas are generally "legacy" bits of code. Generally thego:generatepre-dated the existence of the Bazel code generation. There isn't an expectation that one be added assuming you are writing new code.
Removed.
|
@rickystewart want to merge this now? |
|
@rickystewart I no longer have the power to bors, so if you'd give 'er a |
|
bors r+ |
Relates to #118490.
Epic: None
Release note: None