builtin/provider/terraform: Add field descriptions #26836
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
Codecov Report
|
alisdair
approved these changes
Nov 6, 2020
nfagerlund
approved these changes
Nov 6, 2020
There was a problem hiding this comment.
Awesome!
Re: grammar, this looks good to me. Two things about that:
- The most important thing to me is making sure a given set of things doesn't have a mixture of sentence-punctuation and fragment-punctuation. So if one or two items in a set need to be full sentences, we should also style the rest of them with periods at the end.
- Even though these descriptions don't seem like "complete" sentences (with subject object verb), it's totally valid to read them as sentences in the context of a surrounding dialog. Like: "What is this?" "The workspace to use." See? And in this case, the surrounding dialog is defined by the usage context (completion helpers) and the other members of the set.
Does that make sense?
|
That makes sense, thank you for the explanation and review Nick! |
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
These fields are well documented in the docs, but this provides descriptions for the schema export (
terraform providers schema -json) which is in turn used by the language server.In other words this enhances the user experience of user editing configuration with the Terraform language server - we can display these descriptions e.g. in completion selectbox or on hover.
I have mostly copy-pasted these from the linked docs and it seems that we use dot at the end of every description. I'm assuming this is intended, even though in most cases it's not a full sentence? Someone with better english grammar knowledge please confirm or correct me if I'm wrong. cc @nfagerlund