t8code icon indicating copy to clipboard operation
t8code copied to clipboard

Improvement: Remove forest argument from adapt callback

Open spenke91 opened this issue 7 months ago • 0 comments

Closes #1279

Describe your changes here:

In line with #1279, this PR removes the forest argument, i.e., the uncommitted new forest, from the adapt callback arguments.

So far, this is just a draft: While the removal of the argument is already completed, #1279 additionally discussed the option of moderating this breaking change by using C++'s [[ deprecated ]] keyword. This is still to be done.

All these boxes must be checked by the AUTHOR before requesting review:

  • [x] The PR is small enough to be reviewed easily. If not, consider splitting up the changes in multiple PRs.
  • [x] The title starts with one of the following prefixes: Documentation:, Bugfix:, Feature:, Improvement: or Other:.
  • [x] If the PR is related to an issue, make sure to link it.
  • [ ] The author made sure that, as a reviewer, he/she would check all boxes below.

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 CMake files.
  • [ ] The code is well documented. In particular, 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.
  • [ ] The code coverage of the project (reported in the CI) should not decrease. If coverage is decreased, make sure that this is reasonable and acceptable.
  • [ ] Valgrind doesn't find any bugs in the new code. This script can be used to check for errors; see also this wiki article.

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 or tutorial and a Wiki article.

License

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

spenke91 avatar Jul 02 '25 07:07 spenke91