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

Rename the Extensions and Attributes classes #30

Open
hyblocker opened this issue Dec 12, 2022 · 0 comments
Open

Rename the Extensions and Attributes classes #30

hyblocker opened this issue Dec 12, 2022 · 0 comments

Comments

@hyblocker
Copy link

C# encourages users to add numerous using statements to hide lots of namespaces in codebases. This library has two classes: VRC.OSCQuery.Extensions and VRC.OSCQuery.Attributes which are under the VRC.OSCQuery namespace, whose very generic naming scheme (simply Extensions and Attributes) makes these classes very prone to ambiguity in C# codebases.

Prefixing these classes with the name OSC would probably make sense as:

  • This would immediately imply to a programmer who is learning how to use the API via IntelliSense that the Extension and Attributes classes belong to the OSCQuery library, and not one of the other libraries someone might have installed in their project.
  • It reduces ambiguity by default. This is ideal for libraries, as a project using such a library typically has it's own classes with the same names.

The main downside of this is the fact that this would be a breaking API change.

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