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 a few typos in the datamodel specification #1716

Merged
merged 4 commits into from
May 21, 2021

Conversation

pirgeo
Copy link
Member

@pirgeo pirgeo commented May 20, 2021

Changes

  • Fix a few typos
  • Update the references pointing to metric point types in the proto and fix the proto version in the reference. I am not sure if there is a more elegant way of referencing the proto at a specific line while still pointing at the latest proto version. Doing it this way, the reference will always point at the right line. On the flip side, the references have to be updated every time a new version of the proto is released. Is there a preferred way to do this?

@pirgeo pirgeo requested review from a team May 20, 2021 14:22
@arminru arminru added area:data-model For issues related to data model editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. spec:metrics Related to the specification/metrics directory labels May 20, 2021
Copy link
Member

@arminru arminru left a comment

Choose a reason for hiding this comment

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

Thanks!
I think pointing to proto@v0.9.0 is fine to have stable references, let's see what the @open-telemetry/specs-metrics-approvers say.

@tigrannajaryan
Copy link
Member

Thanks!
I think pointing to proto@v0.9.0 is fine to have stable references, let's see what the @open-telemetry/specs-metrics-approvers say.

I think referring to a specific version is a safer approach. If we point to main and it changes we need to update the references anyway. If updating the references is a requirement to keep the spec correct then I would rather link to specific versions and ensure it is never broken, just maybe outdated if a newer version is released (which I think is less bad).

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented May 20, 2021

CLA Signed

The committers are authorized under a signed CLA.

Copy link
Member

@reyang reyang left a comment

Choose a reason for hiding this comment

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

LGTM.

@arminru arminru merged commit f92ef06 into open-telemetry:main May 21, 2021
@arminru arminru deleted the datamodel-typos branch May 21, 2021 16:15
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
area:data-model For issues related to data model editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. spec:metrics Related to the specification/metrics directory
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants