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

Respect JavaScript naming conventions #3386

Open
joshunrau opened this issue Aug 27, 2024 · 2 comments
Open

Respect JavaScript naming conventions #3386

joshunrau opened this issue Aug 27, 2024 · 2 comments

Comments

@joshunrau
Copy link
Contributor

I have just starting using this package and am really enjoying it! However, I have noticed methods are named inconsistently (some with camelCase, some with snake_case). Since this is a JavaScript package, I would propose using camelCase for all method, function, or variable names. The old snake_case names can be deprecated and aliased to the camelCase names without causing any breaking changes. If it would be helpful, I can make a PR for this.

@jodeleeuw
Copy link
Member

Thanks @joshunrau. I'm not opposed to making the switch; my only concern is that there is 10 years worth of content (docs, recorded talks, etc.) that uses snake case for timeline/trial parameters. Since many researchers get introduced to JS programming through this library, the disconnect between existing docs might be especially confusing. But, if everything is aliased and there's deprecation warnings it seems like the trade off is probably worth it.

@jspsych/core any thoughts?

I think if there are no objections, then a PR would be very helpful.

@joshunrau
Copy link
Contributor Author

Awesome! I am hoping to make a lot of contributions to this project since I think it could be really nicely integrated into what we are doing (Open Data Capture).

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

2 participants