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

update documentation references to fix broken reference links on SwiftPackageIndex hosted documentation for main #143

Merged
merged 2 commits into from
Mar 29, 2024

Conversation

heckj
Copy link
Contributor

@heckj heckj commented Mar 28, 2024

While reading through the documentation at SwiftPackageIndex, I found a number of places where a disambiguation marker had changed since the documentation was written, leaving a warning in it's place - and worse, not providing the reference intended.

I changed instances of withSpan(_:context:ofKind:at:function:file:line:_:)-4o2b to withSpan(_:context:ofKind:at:function:file:line:_:)-8gw3v, used in the following context:

In order to avoid this duplicate work, it is beneficial to use the
``withSpan(_:context:ofKind:at:function:file:line:_:)-8gw3v`` overload, 
which also accepts a `ServiceContext` as parameter, rather than picking it up from the task-local value:

There were several overloads to choose from, and I think this is the most relevant one to run with. If another is more appropriate, I'm happy to make the relevant updates in this PR

Copy link
Collaborator

@slashmo slashmo left a comment

Choose a reason for hiding this comment

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

Thanks, the overloads you chose look sensible to me 👍

Sources/Tracing/SpanProtocol.swift Outdated Show resolved Hide resolved
Co-authored-by: Moritz Lang <hi@slashmo.codes>
@ktoso
Copy link
Member

ktoso commented Mar 29, 2024

@swift-server-bot add to allowlist

@ktoso
Copy link
Member

ktoso commented Mar 29, 2024

@swift-server-bot test this please

@ktoso ktoso merged commit ddc7470 into apple:main Mar 29, 2024
6 checks passed
@ktoso ktoso added this to the 1.1.x milestone Mar 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants