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

More const params #808

Merged
merged 5 commits into from
Nov 2, 2023
Merged

More const params #808

merged 5 commits into from
Nov 2, 2023

Conversation

Davknapp
Copy link
Collaborator

@Davknapp Davknapp commented Oct 26, 2023

In many cases we want to get something from the forest, but the params of these getter functions weren't const.
It anoyed me and on this branch I introduced const params for the most easy getter functions, where I did not have to introduce bigger changes.

All these boxes must be checked by the reviewers before merging the pull request:

As a reviewer please read through all the code lines and make sure that the code is fully understood, bug free, well-documented and well-structured.

General

  • The reviewer executed the new code features at least once and checked the results manually

  • The code follows the t8code coding guidelines

  • New source/header files are properly added to the Makefiles

  • The code is well documented

  • All function declarations, structs/classes and their members have a proper doxygen documentation

  • All new algorithms and data structures are sufficiently optimal in terms of memory and runtime (If this should be merged, but there is still potential for optimization, create a new issue)

Tests

  • The code is covered in an existing or new test case using Google Test

Github action

  • The code compiles without warning in debugging and release mode, with and without MPI (this should be executed automatically in a github action)

  • All tests pass (in various configurations, this should be executed automatically in a github action)

    If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):

    • Should this use case be added to the github action?
    • If not, does the specific use case compile and all tests pass (check manually)

Scripts and Wiki

  • If a new directory with source-files is added, it must be covered by the script/find_all_source_files.scp to check the indentation of these files.
  • If this PR introduces a new feature, it must be covered in an example/tutorial and a Wiki article.

Licence

  • The author added a BSD statement to doc/ (or already has one)

@Davknapp Davknapp added enhancement Enhances already existing code shouldn't take long Can be resolved in under 30 mins labels Oct 26, 2023
Copy link
Collaborator

@sandro-elsweijer sandro-elsweijer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@sandro-elsweijer sandro-elsweijer merged commit 71ba9b1 into main Nov 2, 2023
@sandro-elsweijer sandro-elsweijer deleted the more_const_params branch November 2, 2023 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhances already existing code shouldn't take long Can be resolved in under 30 mins
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants