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

chore(doc): remove redundant punctuation marks #16508

Closed
wants to merge 1 commit into from

Conversation

caicancai
Copy link

I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.

What's changed and what's your intention?

Checklist

  • I have written necessary rustdoc comments
  • I have added necessary unit tests and integration tests
  • I have added test labels as necessary. See details.
  • I have added fuzzing tests or opened an issue to track them. (Optional, recommended for new SQL features Sqlsmith: Sql feature generation #7934).
  • My PR contains breaking changes. (If it deprecates some features, please create a tracking issue to remove them in the future).
  • All checks passed in ./risedev check (or alias, ./risedev c)
  • My PR changes performance-critical code. (Please run macro/micro-benchmarks and show the results.)
  • My PR contains critical fixes that are necessary to be merged into the latest release. (Please check out the details)

Documentation

  • My PR needs documentation updates. (Please use the Release note section below to summarize the impact on users)

Release note

If this PR includes changes that directly affect users or other significant modifications relevant to the community, kindly draft a release note to provide a concise summary of these changes. Please prioritize highlighting the impact these changes will have on users.

@caicancai caicancai changed the title chore: remove redundant punctuation marks chore(doc): remove redundant punctuation marks Apr 26, 2024
@xxchan
Copy link
Member

xxchan commented Apr 27, 2024

Thanks for your contribution.

In British English, “i.e.” and “e.g.” are not followed by a comma, so the first example above would be:

They sell computer components, e.g. motherboards, graphic cards, CPUs.

Virtually all American style guides recommend to follow both “i.e.” and “e.g.” with a comma (just like if “that is” and “for example” were used instead), so the very same sentence in American English would become:

They sell computer components, e.g., motherboards, graphic cards, CPUs.

https://jakubmarian.com/comma-after-i-e-and-e-g/

Therefore, I think it's find to put a punctuation mark here.

@caicancai
Copy link
Author

Thank you for your patient explanation, which helped me learn new knowledge.
closing

@caicancai caicancai closed this Apr 27, 2024
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.

2 participants