Skip to content
This repository has been archived by the owner on Nov 10, 2022. It is now read-only.

docs: fix rendering of tracer.startActiveSpan examples #107

Closed

Conversation

trentm
Copy link
Contributor

@trentm trentm commented Jul 23, 2021

Before (at https://open-telemetry.github.io/opentelemetry-js-api/interfaces/tracer.html):

Screen Shot 2021-07-22 at 5 57 19 PM

after:

Screen Shot 2021-07-22 at 5 57 41 PM

https://typedoc.org/guides/doccomments/ doesn't document the @example tag that I could see, so this is a guess that it meets the requirements to get picked up as a code block (given Markdown requires 4 leading spaces for that).

@codecov
Copy link

codecov bot commented Jul 23, 2021

Codecov Report

Merging #107 (87db2bb) into main (14655bc) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #107   +/-   ##
=======================================
  Coverage   94.89%   94.89%           
=======================================
  Files          42       42           
  Lines         568      568           
  Branches       89       89           
=======================================
  Hits          539      539           
  Misses         29       29           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 14655bc...87db2bb. Read the comment docs.

Copy link
Member

@naseemkullah naseemkullah left a comment

Choose a reason for hiding this comment

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

lgtm, but seems to be a dupe of #101

happy to see either of these merged

@trentm
Copy link
Contributor Author

trentm commented Jul 24, 2021

seems to be a dupe of #101

Ah, I hadn't looked. Thanks for finding the dupe. Likewise I'm happy for either one to get merged.

Copy link
Member

@johnbley johnbley left a comment

Choose a reason for hiding this comment

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

Yes, either 107 or 101 look great.

@dyladan
Copy link
Member

dyladan commented Jul 26, 2021

Dupe of #101

@dyladan dyladan closed this Jul 26, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants