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

Code size vs readability #143

Closed
egfx-notifications opened this issue Oct 26, 2022 · 3 comments
Closed

Code size vs readability #143

egfx-notifications opened this issue Oct 26, 2022 · 3 comments

Comments

@egfx-notifications
Copy link
Contributor

It has been a few months since I was last able to keep track of the developments in croner. Reading up on the changes (and there have been a lot of nice improvements!) I'd like to debate whether the changes to variable names in 390ebca are really a good trade-off.
While it certainly makes the code size smaller, I think it also makes the code less readable. I always thought of croner as a very well written, easy to understand library. So I'm afraid this change will introduce some tribal knowledge to the code which makes it harder for future contributors to get up to speed. Being a backend developer, I do not usually care that much about binary size, so maybe it is worth the reduction in readability and I'm just wrong. Still I'm wondering if there would not be a better solution for this (uglify, etc.) which provides small code size for shipping the code while keeping the code nice and clear for development. At least we could make sure that all those shorthand property names have solid doc comments.

@Hexagon
Copy link
Owner

Hexagon commented Oct 26, 2022

Thanks for the input. I'll think about this until next release 👍

@Hexagon
Copy link
Owner

Hexagon commented Oct 26, 2022

You're totally right. The difference were 300 bytes (!)... Will restore some of the changes, and also add some missing JSDocs :)

@Hexagon
Copy link
Owner

Hexagon commented Oct 26, 2022

Fixed in 304fd05

@Hexagon Hexagon closed this as completed Oct 29, 2022
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