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

Typo in solidWs usage in documentation #26

Open
melvincarvalho opened this issue Oct 8, 2024 · 0 comments
Open

Typo in solidWs usage in documentation #26

melvincarvalho opened this issue Oct 8, 2024 · 0 comments

Comments

@melvincarvalho
Copy link
Contributor

Description:
In the usage examples within the README, the solidWs function is imported as SolidWs but used as solidWs. For consistency and convention in JavaScript (camelCase for functions), the import should be changed to solidWs.

Proposed fix:
In the "Short way" and "Long way" examples, update the import statement to:

var solidWs = require('solid-ws')

This will maintain consistency with the function call solidWs(server).

melvincarvalho added a commit to melvincarvalho/node-solid-ws that referenced this issue Oct 8, 2024
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