AMICI-dev / AMICI

Advanced Multilanguage Interface to CVODES and IDAS
https://amici.readthedocs.io/
Other
108 stars 30 forks source link

Coherent style #887

Open dweindl opened 4 years ago

dweindl commented 4 years ago

At some point, we should give the AMICI API a makeover. Things like the mix of camelcase and snakecase in arguments of the same function are annoying/confusing. Also parameters referring to the same entity would ideally have same name when occurring in different function signatures.

Also: In C++ we are using camelcase, in python snakecase. This leads to a funny mix in the Python API. "Deal with it" or do we want to make that a bit more coherent at some point (i.e. snakecase for C++)?

FFroehlich commented 4 years ago

Agreed. I would vote for having snakecase in C++ (requires a bit of work though).

paulstapor commented 4 years ago

So, the vote is for snakecase in C++? I'm asking because I'm writing a new spline implementation in C++ right now, and would be happy to directly stick to the correct naming... :)

dweindl commented 4 years ago

So, the vote is for snakecase in C++?

Mine is for https://google.github.io/styleguide/cppguide.html

paulstapor commented 4 years ago

Okay, looks like a rather extensive style guide... Totally fine for me to fix this one as a reference...