Skip to content

Conversation

@holke
Copy link
Collaborator

@holke holke commented Jan 15, 2026

Describe your changes here:

Closes #2077

Changes "class" to "struct" throughout the code base (not in mesh handle).
We decided to do this since some of our C code requires structs and classes and structs got mixed up and we encountered some unnecessary compiler errors.
To have a unique solution we switch to struct everywhere.

Please double check that i added the "private/protected/public" modifiers if they were necessary.

I decided against changing the wording of comments. I.e. a comment saying "This class does ..." still reads class, since i feel it is still valid to talk about a struct as a "class" in a comment.

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

  • The PR is small enough to be reviewed easily. If not, consider splitting up the changes in multiple PRs.
  • The title starts with one of the following prefixes: Documentation:, Bugfix:, Feature:, Improvement: or Other:.
  • 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. Make sure to add a file documentation for each file!
  • 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).

@codecov
Copy link

codecov bot commented Jan 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.46%. Comparing base (4665876) to head (19e1357).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2098   +/-   ##
=======================================
  Coverage   77.46%   77.46%           
=======================================
  Files         112      112           
  Lines       19084    19084           
=======================================
  Hits        14784    14784           
  Misses       4300     4300           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@holke holke marked this pull request as draft January 16, 2026 08:54
@holke holke added enhancement Enhances already existing code cleanup Cleans the code workload:low Would take half a day or less labels Jan 16, 2026
@holke holke marked this pull request as ready for review January 16, 2026 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cleanup Cleans the code enhancement Enhances already existing code workload:low Would take half a day or less

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improvement: Rename all instances of class to struct

2 participants