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 non-ASCII characters by ASCII characters in the names of variables, structs, functions and macros #388

Merged

Conversation

CFBaptista
Copy link
Contributor

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

  • Updated tests or added new tests
  • Branch is up to date with master
  • Tests & pre-commit hooks pass
  • Updated documentation if needed
  • Updated changelog.md if needed

@CFBaptista CFBaptista added the v1.0 Activities related to v1.0 label Apr 10, 2024
@CFBaptista CFBaptista linked an issue Apr 10, 2024 that may be closed by this pull request
Copy link
Contributor

@verseve verseve left a 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).

src/flextopo_model.jl Outdated Show resolved Hide resolved
src/flextopo_model.jl Outdated Show resolved Hide resolved
src/flextopo_model.jl Outdated Show resolved Hide resolved
src/flow.jl Outdated Show resolved Hide resolved
src/flow.jl Outdated Show resolved Hide resolved
test/groundwater.jl Outdated Show resolved Hide resolved
test/groundwater.jl Outdated Show resolved Hide resolved
test/groundwater.jl Show resolved Hide resolved
test/groundwater.jl Outdated Show resolved Hide resolved
test/horizontal_process.jl Outdated Show resolved Hide resolved
@CFBaptista CFBaptista force-pushed the refactor/replace_non_ascii_characters_by_ascii_characters branch from f50c599 to ca0ab08 Compare April 17, 2024 15:57
Copy link
Contributor

@JoostBuitink JoostBuitink left a 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?

docs/src/model_docs/params_vertical.md Outdated Show resolved Hide resolved
docs/src/model_docs/params_vertical.md Outdated Show resolved Hide resolved
CFBaptista and others added 2 commits April 18, 2024 12:43
@verseve
Copy link
Contributor

verseve commented Apr 18, 2024

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?

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.

@CFBaptista CFBaptista merged commit cccf5cd into master Apr 18, 2024
10 checks passed
@CFBaptista CFBaptista deleted the refactor/replace_non_ascii_characters_by_ascii_characters branch April 18, 2024 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v1.0 Activities related to v1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unicode Character Usage and Consistency
3 participants