Fix typos of “it's” where “its” is meant #2039
Conversation
| @@ -608,7 +608,7 @@ class SpanAttributes: | |||
| MESSAGING_KAFKA_MESSAGE_KEY = "messaging.kafka.message_key" | |||
| """ | |||
| Message keys in Kafka are used for grouping alike messages to ensure they're processed on the same partition. They differ from `messaging.message_id` in that they're not unique. If the key is `null`, the attribute MUST NOT be set. | |||
| Note: If the key type is not string, it's string representation has to be supplied for the attribute. If the key has no unambiguous, canonical string form, don't include its value. | |||
| Note: If the key type is not string, its string representation has to be supplied for the attribute. If the key has no unambiguous, canonical string form, don't include its value. | |||
There was a problem hiding this comment.
| Note: If the key type is not string, its string representation has to be supplied for the attribute. If the key has no unambiguous, canonical string form, don't include its value. | |
| Note: If the key type is not `string`, its string representation has to be supplied for the attribute. If the key has no unambiguous, canonical string form, do not include its value. |
Just a passing by comment about some further doc wins I think we could get 🙂
There was a problem hiding this comment.
The monospace formatting on string makes sense.
For “don't”→“do not”, are you trying to discourage contractions in the documentation as a matter of style? They are currently rather widely used.
There was a problem hiding this comment.
Yes, I just have a personal custom to discourage contractions in documentation, but it's not a SIG requirement so it's up to you!
There was a problem hiding this comment.
OK, how would you feel about me introducing those two changes (and replacing other contractions at the same time) in a follow-up PR instead?
There was a problem hiding this comment.
Definitely okay with you leaving out the contraction change, but truthfully I wouldn't go through the effort of changing contractions everywhere because other members in the SIG might disagree with me. We can discuss at the SIG meeting next week if that's something people want, or you could raise an issue first for visibility in case and gauge interest from the community 🙂
Description
This PR fixes typos where
it's(“it is”) is written, but context indicatesits(possessive) is intended.There is no open issue for these typos. I have marked it as a bug fix since some typos are user-visible.
Type of change
How Has This Been Tested?
I did not test it at all, since it contains only trivial string changes.
Does This PR Require a Contrib Repo Change?
Answer the following question based on these examples of changes that would require a Contrib Repo Change:
The OTel specification has changed which prompted this PR to update the method interfaces of
opentelemetry-api/oropentelemetry-sdk/The method interfaces of
opentelemetry-instrumentation/have changedThe method interfaces of
test/utilhave changedScripts in
scripts/that were copied over to the Contrib repo have changedConfiguration files that were copied over to the Contrib repo have changed (when consistency between repositories is applicable) such as in
pyproject.tomlisort.cfg.flake8When a new
.github/CODEOWNERis addedMajor changes to project information, such as in:
README.mdCONTRIBUTING.mdYes. - Link to PR:
No.
Checklist: