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

Unicode Character Usage and Consistency #352

Closed
alimeshgi opened this issue Feb 9, 2024 · 1 comment · Fixed by #388
Closed

Unicode Character Usage and Consistency #352

alimeshgi opened this issue Feb 9, 2024 · 1 comment · Fixed by #388
Assignees
Labels
user-experience Improvements to the settings file, logging, error handling, etc. v1.0 Activities related to v1.0
Milestone

Comments

@alimeshgi
Copy link

alimeshgi commented Feb 9, 2024

Feature type

Changing existing functionality

Improvement Description

The current codebase utilizes Unicode characters inconsistently. The advantage of Unicode characters is that the implementation remains close to the model equations, making the code more readable and easier to understand (improving maintainability of the code). In addition, to make fully use of Unicode characters, these characters should also be included in the documentation (code notation matches notation in documentation). Possible disadvantages of using Unicode characters are: more difficult to type, searching (example is required) and editor or text processor could have problems correctly displaying these characters (config TOML file). It's essential to evaluate the usage of Unicode characters, considering their advantages and disadvantages, and ensure consistent usage throughout the codebase.

Implementation Description

Make a well considered choice (use consistent or not) and refactor the code (and change docs) based on the choice.

Additional Context

No response

@alimeshgi alimeshgi added user-experience Improvements to the settings file, logging, error handling, etc. needs refinement issue still needs refinement v1.0 Activities related to v1.0 labels Feb 9, 2024
@alimeshgi alimeshgi modified the milestones: 2024 - Q2, Q, Q3-2024 Mar 21, 2024
@JoostBuitink
Copy link
Contributor

We have decided to stop using unicode characters, and spell them out if necessary (for example theta_s instead of the Greek symbol). We aim for the variables to be as descriptive as possible, while ensuring the names won't get too long as that could limit readability of the code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
user-experience Improvements to the settings file, logging, error handling, etc. v1.0 Activities related to v1.0
Projects
None yet
3 participants