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

Prefix non-datatype properties and methods with $ #977

Open
gmaclennan opened this issue Dec 13, 2024 · 0 comments
Open

Prefix non-datatype properties and methods with $ #977

gmaclennan opened this issue Dec 13, 2024 · 0 comments

Comments

@gmaclennan
Copy link
Member

Our initial intention with the API was to prefix all properties and methods that are not datatypes with $. The reason for this was to remove the possibility of a naming conflict between a datatype name and a property or method on the API. We have forgotten about this with some of our naming:

  • project.deviceId
  • project.importConfig()
  • project.ready()
  • project.close()

I think the original intention and reasoning was valid, so I think we should rename these properties and methods. This will be a breaking change for the API, but should be easy to manage because we ship the API with the app. This is non-urgent, but I think worth addressing at some point.

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