-
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
Replace non-ASCII characters by ASCII characters in the names of variables, structs, functions and macros #388
Replace non-ASCII characters by ASCII characters in the names of variables, structs, functions and macros #388
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for these changes. I did make some suggestions for changes in the code (did not mark these in the docs, of course some changes also affect the doc files).
f50c599
to
ca0ab08
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for all of these changes, LGTM! I have only two small comments.
I decided to explore whether it is possible to change the (many) beta's into more descriptive names, but most of these originate in the kinematic wave equations, where they are originally also described as a \beta (without a real meaning, other than being a constant). So I think it is best to stay close to these equations. Some are in the flextopo and HBV concepts, where I believe it is also best to keep them as they are. What do you think @verseve?
Co-authored-by: JoostBuitink <[email protected]>
Co-authored-by: JoostBuitink <[email protected]>
Yes, I think for now it is best to keep these variable names as they are. If we want to change this (also my comment in Teams about variable name consistency) we can work on this as part of another issue/PR. |
Issue addressed
Fixes #352
Explanation
For improved code readability it is now discouraged to use non-ASCII characters for naming variables, structs, functions and macros. Using the non-ASCII character for built-in operators is still allowed. This change in naming convention is now in effect and all invalid uses of non-ASCII characters have been replaced by ASCII equivalents.
Checklist
master