Skip to content
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

Fix punctuation and spelling errors in Basic CLI Features and Command: plan documentation #32791

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

iKunal-Singh
Copy link

@iKunal-Singh iKunal-Singh commented Mar 7, 2023

This PR changes mistakes in index.mdx and plan.mdx terraform docs.
Changes in the index.mdx

  • Removed unnecessary comma in a compound object. Because a compound object with only two items requires no punctuation to separate them.
  • Corrected the spelling of "into" as it should be one word.
  • Eliminated redundant preposition "for" from the documentation.

Changes in the plan.mdx

  • Removed incorrect preposition "for".
  • Corrected the spelling of "configuratation" as it should be "configuration".
  • Corrected the pronoun "which match" as it should be "that match".
  • Added necessary commas.
  • Corrected the use of incorrect form of verb "write" as it should be "writing"

UPGRADE NOTES

@hashicorp-cla
Copy link

hashicorp-cla commented Mar 7, 2023

CLA assistant check
All committers have signed the CLA.

@iKunal-Singh iKunal-Singh changed the title Fix punctuation and spelling errors in Basic CLI Features documentation Fix punctuation and spelling errors in Basic CLI Features and Command: plan documentation Mar 7, 2023
@crw
Copy link
Collaborator

crw commented Mar 7, 2023

Thanks for this submission! I am going to submit this to the docs team for review as it makes a few minor grammatical changes, and ultimately that team owns the docs style.

@iKunal-Singh
Copy link
Author

iKunal-Singh commented Mar 8, 2023 via email

@@ -57,7 +57,7 @@ All other commands:
Global options (use these before the subcommand, if any):
-chdir=DIR Switch to a different working directory before executing the
given subcommand.
-help Show this help output, or the help for a specified subcommand.
-help Show this help output or the help for a specified subcommand.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we can change this because it is a representation of the actual CLI output, not just docs about it. We could correct the CLI output itself, but I don't want to update the docs without doing that first or they won't match.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants