-
Notifications
You must be signed in to change notification settings - Fork 18
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
base: master
Are you sure you want to change the base?
Conversation
vladdoster
commented
Jan 21, 2021
- fix grammar
- fix spelling
- increase readability for a non-native speaker (me)
- fix grammar - fix spelling - increase readability for a non-native speaker (me)
There was a problem hiding this 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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is an introductory clause warranting a comma.
https://owl.purdue.edu/owl/general_writing/punctuation/commas/commas_after_introductions.html
There was a problem hiding this comment.
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".
There was a problem hiding this comment.
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.