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 typos and grammar in the OTLP spec #3121

Merged
merged 19 commits into from
Feb 22, 2023

Conversation

moonbox3
Copy link
Contributor

Fixes #3120

Changes

This PR fixes typos and grammatical errors in the OTLP spec. Additionally, there were several places where text contained passive voice. These were updated to active voice to make them easier to follow.

@moonbox3 moonbox3 requested review from a team January 20, 2023 16:41
@moonbox3
Copy link
Contributor Author

Does this change require a changelog?

Copy link
Member

@tigrannajaryan tigrannajaryan 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 for the fixes @moonbox3

Some of the changes DO change the meaning, so I am temporarily blocking to fix those.

specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Show resolved Hide resolved
@moonbox3
Copy link
Contributor Author

Thank you for the fixes @moonbox3

Some of the changes DO change the meaning, so I am temporarily blocking to fix those.

Thank you for your review, @tigrannajaryan. I appreciate it. I have addressed your comments/suggestions.

@carlosalberto
Copy link
Contributor

Btw we don't use comma after e.g. nor i.e. in general - according to Wiktionary:

"E.g." and its examples are typically set off from the rest of the sentence by punctuation. In US English, "e.g." is usually followed by a comma.[2] It is not followed by a comma in other English-speaking countries.

So we should probably stick to the comma-less form for now, given we already use that and, technically, it's not incorrect.

@moonbox3
Copy link
Contributor Author

Btw we don't use comma after e.g. nor i.e. in general - according to Wiktionary:

"E.g." and its examples are typically set off from the rest of the sentence by punctuation. In US English, "e.g." is usually followed by a comma.[2] It is not followed by a comma in other English-speaking countries.

So we should probably stick to the comma-less form for now, given we already use that and, technically, it's not incorrect.

@carlosalberto Thank you for your comment. Is there a style guide I should be following?

@arminru arminru added the editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. label Jan 23, 2023
specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
@moonbox3 moonbox3 requested review from MrAlias and removed request for tigrannajaryan January 25, 2023 18:23
@moonbox3
Copy link
Contributor Author

@tigrannajaryan or @MrAlias can you please help review the final changes? Thank you.

@github-actions
Copy link

github-actions bot commented Feb 4, 2023

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Feb 4, 2023
@moonbox3
Copy link
Contributor Author

moonbox3 commented Feb 8, 2023

I would prefer for this PR to not be closed due to lack of activity. Can I get some help on it, please? Thank you.

@moonbox3 moonbox3 requested review from tigrannajaryan and removed request for MrAlias February 8, 2023 21:56
@yurishkuro yurishkuro removed the Stale label Feb 8, 2023
@github-actions
Copy link

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions github-actions bot added the Stale label Feb 16, 2023
@MrAlias MrAlias removed the Stale label Feb 16, 2023
@carlosalberto
Copy link
Contributor

Thanks @moonbox3 - looks good to go IMHO.

cc @tigrannajaryan

Copy link
Member

@tigrannajaryan tigrannajaryan left a comment

Choose a reason for hiding this comment

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

Just 2 small comments left, the rest looks good to me.

specification/protocol/otlp.md Outdated Show resolved Hide resolved
specification/protocol/otlp.md Outdated Show resolved Hide resolved
@moonbox3
Copy link
Contributor Author

moonbox3 commented Feb 22, 2023

Thank you all for the help. @tigrannajaryan I addressed your two final comments. Thank you.

@tigrannajaryan
Copy link
Member

Thank you @moonbox3 for making the spec clearer.

@reyang reyang merged commit 639864e into open-telemetry:main Feb 22, 2023
jsuereth pushed a commit to jsuereth/opentelemetry-specification that referenced this pull request Feb 28, 2023
carlosalberto pushed a commit to carlosalberto/opentelemetry-specification that referenced this pull request Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix typos and grammar in the OTLP specification
8 participants