Skip to content

Conversation

@haakon-e
Copy link
Member

@haakon-e haakon-e commented Nov 25, 2025

This pull request primarily improves code readability and maintainability in src/solver/type_getters.jl by reformatting code for consistency, adding helpful docstrings to key functions, and simplifying multi-line statements. There are no functional changes to the logic, but the code is now easier to read, understand, and maintain.

Documentation improvements:

  • Added docstrings to important functions such as get_atmos, get_numerics, get_spaces, ode_configuration, and get_sim_info, providing clear explanations of their purpose and usage. [1] [2] [3] [4] [5]

Code formatting and readability:

Warnings and error messages:

  • Reformatted warning and error messages to use single-line strings or more readable multi-line strings, making logs and errors easier to interpret. [1] [2] [3] [4]

Other minor cleanups:

  • Simplified function signatures and removed unnecessary comments or commented-out code. [1] [2]

These changes do not alter any functionality but make the codebase easier to work with and maintain.

@haakon-e
Copy link
Member Author

cc: @nefrathenrici I know you're working on an updated interface for all of this, but if that's still some ways out, I'd propose merging this, which should improve readability of these important functions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants