-
Notifications
You must be signed in to change notification settings - Fork 21
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
Formatting Issue #10
Comments
Hey, feel free to join the Discord and ping me for any clarifications or questions in general https://discord.gg/E6pK7VpnjC
I consider the code to be already formatted, it's just an unconventional formatting which won't be changed.
I suppose some comments could be added, I think you are referring to JSDoc-style comments specifically, I've opened a dedicated issue for that: #12 In general though the code IMO serves 2 purposes, be easy to work with for whoever is making the commits, and be performant/correct for whoever is executing it. Code is not meant to make the library easily understood by other people, some standalone dedicated documentation should be written for that, I've opened an issue to keep track of that (since the current readme is not really proper documentation): #11 |
As a quick shortcut this framework should work similarly to Solid, so you can largely check out their documentation and their Urql bindings to learn more about how the framework works and how the bindings should be done. |
So you are telling me that you can't correctly format the code & I have to learn solid.js to contribute to voby. These is inconvenient & the CLI is formatted correctly but Voby & Oby are not, what up with the formatting in voby-js org? |
No, I'm telling you that the code is correctly formatted already as far as I'm concerned, and since this is an early project it is unfortunately basically not documented, and since Solid is a similar framework you could in part use their documentation to learn how to use Voby.
The lead maintainer of each repo writes the code however they like, I'm maintaining the core stuff, I'm picking the formatting that I like. For better or for worse I can't just flip a switch and like Prettier's formatting all of a sudden. |
Please think about it. No One would like to use unformated & ugly code. To me I always use prettier & prettier is my first party vscode plugin. Thanks. |
I understand, but I've given this a fair bit of thought already, I'm not going to switch to Prettier. |
I have seen Voby in Reddit (https://www.reddit.com/r/javascript/comments/ukhv0w/voby_a_new_frontend_framework_with_high/) & I am trying to see the code to create a binding library to Urql GraphQL Client (https://formidable.com/open-source/urql/), but the code is not readable enough because of the formatting & there are no comments that vscode can use to give documentation.
Could You Format the code & add comment documentations?
The text was updated successfully, but these errors were encountered: