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

Replace camelcase #12

Open
jariji opened this issue Aug 19, 2023 · 2 comments
Open

Replace camelcase #12

jariji opened this issue Aug 19, 2023 · 2 comments
Labels
breaking For any change that requires a breaking release to be tagged good first issue Good for newcomers

Comments

@jariji
Copy link

jariji commented Aug 19, 2023

The Julia style guide says

functions are lowercase (maximum, convert) and, when readable, with multiple words squashed together (isequal, haskey). When necessary, use underscores as word separators. Underscores are also used to indicate a combination of concepts (remotecall_fetch as a more efficient implementation of fetch(remotecall(...))) or as modifiers.

Would you mind applying that here? It's easier to learn and use an API if it follows the same conventions as the rest of the ecosystem and doesn't stick out in my code.

That would apply to shrinkTowards and any others.

@Seelengrab Seelengrab added good first issue Good for newcomers breaking For any change that requires a breaking release to be tagged labels Aug 19, 2023
@Seelengrab
Copy link
Owner

Seelengrab commented Aug 19, 2023

Yeah, that can be done. I'm not happy with the current function names either, but noone complained about the names so far 🤷 Is there a style checker that could be used here/run in CI to keep the convention consistent going forward? Otherwise, manual search & replace is doable too.

@jariji
Copy link
Author

jariji commented Aug 19, 2023

Is there a style checker that could be used here/run in CI to keep the convention consistent going forward?

I don't know of one. rg '\b[a-z]+[A-Z]\w+' seems to find them, I imagine any editor can do the replacement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking For any change that requires a breaking release to be tagged good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants