Skip to content

Rename the Extensions and Attributes classes #30

Description

@hyblocker

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions