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

Update syntax in style.md #193

Closed
wants to merge 2 commits into from
Closed

Conversation

lcpulzone
Copy link

An apostrophe was missing from one word and placed in the wrong spot for another word. This PR adds and moves an apostrophe.

An apostrophe was missing from one word and placed in the wrong spot for another word. This PR adds and moves an apostrophe.
@CLAassistant
Copy link

CLAassistant commented Sep 18, 2023

CLA assistant check
All committers have signed the CLA.

@mway
Copy link
Member

mway commented Sep 21, 2023

Hey @lcpulzone, thanks for the PR!

The current state of the guide ("Dos and Don'ts", though "Do's and Don'ts" also appears to be acceptable) is aligned with guidelines and common use across different style guides and publications, as far as I can tell. Some examples:

I think this is OK to leave as-is. Even if there are counter arguments, the intent is clear; it's aligned enough that I don't think we're blatantly misspelling it.

Also, note that style.md should not be updated directly - it is generated, and the source for this particular text is in src/intro.md. See CONTRIBUTING.md for more information.

@mway mway closed this Sep 21, 2023
@lcpulzone lcpulzone deleted the patch-1 branch January 10, 2024 20:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants