opentelemetry-python icon indicating copy to clipboard operation
opentelemetry-python copied to clipboard

Update docs to resolve missing API details for proto gRPC OTLPSpanExporter

Open RobsonSutton opened this issue 3 years ago • 2 comments

Description

  • Resolve missing API details within auto generated docs (https://github.com/open-telemetry/opentelemetry-python/issues/2786)

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • [x] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [x] This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • [ ] Test A

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/ or opentelemetry-sdk/

  • The method interfaces of test/util have changed

  • Scripts in scripts/ that were copied over to the Contrib repo have changed

  • Configuration files that were copied over to the Contrib repo have changed (when consistency between repositories is applicable) such as in

    • pyproject.toml
    • isort.cfg
    • .flake8
  • When a new .github/CODEOWNER is added

  • Major changes to project information, such as in:

    • README.md
    • CONTRIBUTING.md
  • [ ] Yes. - Link to PR:

  • [x] No.

Checklist:

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

RobsonSutton avatar Jul 23 '22 16:07 RobsonSutton

CLA Signed

The committers listed above are authorized under a signed CLA.

  • :white_check_mark: login: RobsonSutton / name: Robson Sutton (2a92899fbba28180b37a89afa1d47bd38ab3253c)

Do you want to update the docs for all exporters or just the span exporter? Please update the title to reflect that.

srikanthccv avatar Jul 24 '22 03:07 srikanthccv

@RobsonSutton, this looks like an easy and important fix. Would you like tidy it up and mark it ready for reviews?

srikanthccv avatar Oct 29 '22 06:10 srikanthccv

@RobsonSutton, another friendly ping. Would you like to tidy this up and make it open for reviews?

srikanthccv avatar Dec 10 '22 01:12 srikanthccv

@srikanthccv - Apologies! Just seen this and completely blanked on this PR..! I'll see if I can carve out some time this week to just finish this up and make it available for merging 👍

RobsonSutton avatar Dec 12 '22 09:12 RobsonSutton

@RobsonSutton friendly ping

srikanthccv avatar Jan 21 '23 07:01 srikanthccv