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.

Sign up for GitHub

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

Jump to bottom

Update environment variable descriptions to match signal #4222

Merged
merged 3 commits into from
Oct 14, 2024
Merged

Update environment variable descriptions to match signal #4222

merged 3 commits into from
Oct 14, 2024

Conversation

kaylareopelle
Copy link
Contributor

@kaylareopelle kaylareopelle commented Oct 11, 2024 •
edited
Loading

Description

Hi Python! 👋 I'm normally in Rubyland, but today I'm investigating OpenTelemetry implementations across different languages to learn more about how they manage configuration. While I was reading opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py, I realized some of the documentation might reference the wrong signals. It seems like they were minor copy/paste oversights.

Type of change

  • This change requires a documentation update

How Has This Been Tested?

Since this is a documentation update, I haven't attempted to test the changes. Happy to find a way to do so if this is required.

Does This PR Require a Contrib Repo Change?

  • Yes. - Link to PR:
  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added (I don't think they're necessary for this change?)
  • Documentation has been updated

kaylareopelle and others added 2 commits October 11, 2024 16:10
@kaylareopelle
chore: Update envvar descriptions to match signal
c8e96c2 
In some cases, a signal different from the one the environment variable was named after was used in the documentation.
@kaylareopelle
chore: Add changelog entry for envvar desc updates
f16efce
@kaylareopelle kaylareopelle changed the title chore: [WIP] Update envvar descriptions to match signal chore: Update envvar descriptions to match signal Oct 11, 2024
@kaylareopelle kaylareopelle changed the title chore: Update envvar descriptions to match signal chore: Update environment variable descriptions to match signal Oct 11, 2024
@kaylareopelle kaylareopelle changed the title chore: Update environment variable descriptions to match signal Update environment variable descriptions to match signal Oct 11, 2024
@kaylareopelle kaylareopelle marked this pull request as ready for review October 11, 2024 23:46
@kaylareopelle kaylareopelle requested a review from a team as a code owner October 11, 2024 23:46
emdneto
emdneto reviewed Oct 12, 2024
View reviewed changes
Copy link
Member

@emdneto emdneto left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Well noticed!
Reading the file I also noticed there are some typos, like repetitive "the the" phrases:

eg., The :envvar:OTEL_EXPORTER_OTLP_LOGS_PROTOCOL represents the the transport protocol for logs.

Do you mind fixing that as well?

@kaylareopelle
Copy link
Contributor Author

Great catch, @emdneto! Fixed in bf0c127

@xrmx xrmx merged commit 6e89388 into open-telemetry:main Oct 14, 2024
378 checks passed
@kaylareopelle kaylareopelle deleted the patch-1 branch October 15, 2024 20:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emdneto emdneto emdneto approved these changes

@xrmx xrmx xrmx approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@kaylareopelle @xrmx @emdneto