PropCheck.jl icon indicating copy to clipboard operation
PropCheck.jl copied to clipboard

Replace camelcase

Open jariji opened this issue 2 years ago • 2 comments

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.

jariji avatar Aug 19 '23 19:08 jariji

Yeah, that can be done. I'm not happy with the current function names either, but noone complained about the names so far :shrug: 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.

Seelengrab avatar Aug 19 '23 20:08 Seelengrab

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.

jariji avatar Aug 19 '23 20:08 jariji