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

Introduce OT prefix #10

Open
ncreated opened this issue Mar 13, 2020 · 0 comments
Open

Introduce OT prefix #10

ncreated opened this issue Mar 13, 2020 · 0 comments

Comments

@ncreated
Copy link

Hello 👋. I came across this project, as I work on a tracer implementation.

The problem

Because of the naming convention opentracing-swift enforces, I'll have to prefix all constructs in my implementation with a custom string, e.g. DDTracer or namespace things by explicitly pointing to the package:

public class Tracer: OpenTracing.Tracer {
   // ...
}

The latter however, might be inconvenient and misleading for users when they import both my implementation and OpenTracing.

Proposed solution

IMHO we might introduce OT prefix in opentracing-swift:

  • OTTracer,
  • OTSpan,
  • OTReference,
  • OTGlobal,
  • ... .

Similar way to what opentracing-objc does.

This will:

  • minimise the number of prefixes that tracer users have to play with,
  • increase the OT APIs discoverability for tracer developers,
  • let people avoid conflicts with the generic names like Reference or Global that they may already use in their projects.

I'm curious what's your take on this 🙂?

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

No branches or pull requests

1 participant