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

(docs) update README.md #121

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

(docs) update README.md #121

wants to merge 1 commit into from

Conversation

vladdoster
Copy link

  • fix grammar
  • fix spelling
  • increase readability for a non-native speaker (me)

- fix grammar
- fix spelling
- increase readability for a non-native speaker (me)
@vladdoster vladdoster requested a review from a team as a code owner January 21, 2021 08:56
Copy link
Collaborator

@venky526 venky526 left a comment

Choose a reason for hiding this comment

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

Thank you! 👍

- `python dashboards.py --api-key mykey update`

If you want to know about the available actions you can take with your new
CLI you can always the `--help` command.
If you want to know about the available actions, you can take with your new
Copy link
Member

Choose a reason for hiding this comment

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

I think this comma should not be added.

Copy link
Author

@vladdoster vladdoster Jan 26, 2021

Choose a reason for hiding this comment

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

Copy link
Member

@jrduncans jrduncans Jan 26, 2021

Choose a reason for hiding this comment

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

The problem is that "you can take with your new CLI" is not an independent clause. The "with" is meaningless without the first part, because the noun phrase is actually "the available actions you can take with your new CLI" with "actions" being the object of the preposition "about" in the conditional clause "If you want to know about...".

It's really the whole thing up to "CLI" that is the introductory clause; the independent clause is "you can always use the --help command".

Copy link
Author

Choose a reason for hiding this comment

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

@jrduncans Ah okay, that makes sense. I appreciate the thorough explanation. I am reverting this change.

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

Successfully merging this pull request may close these issues.

3 participants