Fix spelling in TF docs and related protos #46878
Conversation
Related to #46191 Help us move to a new, more scalable spell checker based on vale by fixing spelling errors in the Terraform provider resource reference docs. This change fixes the spelling in the protobuf messages that these docs are based on. Since the vale checker ignores words in backticks, this change wraps field/value names that would otherwise fail the spell checker in backticks.
ptgott
added
no-changelog
github-actions
bot
requested review from
bernardjkim,
hugoShaka,
marcoandredinis,
mmcallister,
r0mant,
tigrato,
xinding33 and
zmb3
|
🤖 Vercel preview here: https://docs-g0el1xshu-goteleport.vercel.app/docs/ver/preview |
public-teleport-github-review-bot
bot
removed request for
r0mant,
zmb3,
bernardjkim,
hugoShaka and
xinding33
| @@ -27,7 +27,7 @@ message AuthorizedKey { | |||
| teleport.header.v1.Metadata metadata = 1; | |||
| // kind is a resource kind. | |||
| string kind = 2; | |||
| // sub_kind is an optional resource sub kind, used in some resources. | |||
| // an optional resource sub kind, used in some resources. | |||
There was a problem hiding this comment.
The generated go code was not strictly following the go guidelines, but removing the symbnol name from the description will make things worse. According to the go guidelines:
As with packages (above) and funcs (below), doc comments for types start with complete sentences naming the declared symbol. An explicit subject often makes the wording clearer, and it makes the text easier to search, whether on a web page or a command line.
I'm not sure how much we care about following go guidelines on generated go comments, but it feels wrong to have to break our style guidelines here. Maybe ask for a 3rd engineer pov before merging this.
|
This PR has been sitting around for a while, so I am going to close it in favor of ignoring the Vale spellchecker in our auto-generated references to avoid making the first iteration of this project too large. |
Related to #46191
Help us move to a new, more scalable spell checker based on vale by fixing spelling errors in the Terraform provider resource reference docs. This change fixes the spelling in the protobuf messages that these docs are based on.
Since the vale checker ignores words in backticks, this change wraps field/value names that would otherwise fail the spell checker in backticks.