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

fixed extra colon typos in code documentation #3127

Merged
merged 2 commits into from
Jan 13, 2023
Merged

fixed extra colon typos in code documentation #3127

merged 2 commits into from
Jan 13, 2023

Conversation

drichards188
Copy link
Contributor

@drichards188 drichards188 commented Jan 12, 2023

Description

Fixed all found instances of
@tracer.start_as_current_span("name"):
to
@tracer.start_as_current_span("name")
as my understanding is decorators don't have trailing colons

Fixes #3093

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Purely commented code has changed. Shouldn't need to be tested. But very happy to run any suggested tests.

Does This PR Require a Contrib Repo Change?

No

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

.start_as_current_span("name") as decorators do not have colons
@drichards188 drichards188 requested a review from a team January 12, 2023 21:59
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jan 12, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: drichards188 / name: David Richards (dc4b8a5)

Copy link
Member

@srikanthccv srikanthccv left a comment

Choose a reason for hiding this comment

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

Thanks @drichards188

@srikanthccv srikanthccv added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jan 12, 2023
@lzchen lzchen enabled auto-merge (squash) January 12, 2023 22:34
@lzchen lzchen merged commit 5a996fd into open-telemetry:main Jan 13, 2023
@drichards188 drichards188 deleted the typo_fix branch January 13, 2023 02:59
keithkroeger added a commit to fidelity-contributions/open-telemetry-opentelemetry-python that referenced this pull request Jan 13, 2023
* main:
  fixed all instances of @tracer.start_as_current_span("name"): to @tracer.start_as_current_span("name") as decorators do not have colons (open-telemetry#3127)
  Add attribute name to type warning message. (open-telemetry#3124)
  Fix requirements file for example (open-telemetry#3126)
  Add db metric name to semantic conventions (open-telemetry#3115)
  Adds environment variables for log exporter (open-telemetry#3037)
  Fix bug in example (open-telemetry#3111)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

A minor typo in doc: https://opentelemetry-python.readthedocs.io/en/latest/api/trace.html
3 participants