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

Scope docstring is confusing/wrong? #2508

Open
lidavidm opened this issue Jan 24, 2024 · 2 comments
Open

Scope docstring is confusing/wrong? #2508

lidavidm opened this issue Jan 24, 2024 · 2 comments
Labels
Stale triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@lidavidm
Copy link
Contributor

Is your feature request related to a problem?

Scope is documented as "On destruction, the given span is ended":

/**
* Controls how long a span is active.
*
* On creation of the Scope object, the given span is set to the currently
* active span. On destruction, the given span is ended and the previously
* active span will be the currently active span again.
*/

However, from looking through the implementation, it appears only to reset the active span and doesn't actually end the span? Examples in documentation align with this (e.g. creating a scope, then explicitly ending the span). Also, if it did end the span, that would mean there is no (obvious) way to activate a span without ending it.

Describe the solution you'd like
Update the docstring.

Describe alternatives you've considered
N/A

Additional context
N/A

@github-actions github-actions bot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Jan 24, 2024
@lalitb
Copy link
Member

lalitb commented Jan 24, 2024

Agree, feel free to create a PR with the fix. Thanks for reporting.

@marcalff marcalff added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jan 29, 2024
Copy link

This issue was marked as stale due to lack of activity.

@github-actions github-actions bot added the Stale label Mar 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Stale triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

No branches or pull requests

3 participants