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

Merge queue test - [vtk_to_cmesh 1/6] #455

Merged
merged 8 commits into from
Mar 28, 2023
Merged

Merge queue test - [vtk_to_cmesh 1/6] #455

merged 8 commits into from
Mar 28, 2023

Conversation

Davknapp
Copy link
Collaborator

@Davknapp Davknapp commented Mar 7, 2023

Finalize the merge-queue-test with this PR

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.

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

  • The code compiles without warning in debugging and release mode, with and without MPI (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)
  • All tests pass (in various configurations, this should be executed automatically in a github action)

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

  • New Datatypes are added to t8indent_custom_datatypes.txt

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

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

  • New tests use the Google Test framework

  • The code follows the t8code coding guidelines

  • 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)

  • 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.

Knapp and others added 4 commits March 6, 2023 10:29
In the upcoming PRs we will add a vtk reader and want to prevent this file from blowing up.
Therefore I specified the file-name, changed the headers in other files and will soon add a
t8_cmesh_vtk_reader.h
@Davknapp Davknapp changed the title Merge queue test Merge queue test - [vtk_to_cmesh 1/x] Mar 13, 2023
@Davknapp Davknapp changed the title Merge queue test - [vtk_to_cmesh 1/x] Merge queue test - [vtk_to_cmesh 1/6] Mar 13, 2023
Copy link
Collaborator

@chiaraMaHe chiaraMaHe left a comment

Choose a reason for hiding this comment

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

Just one short comment: In t8_vtk.h t8_vtk.h is mentioned in a comment. Should it now mention the writer and the reader or only one of both? - Cannot find how to comment files that are not changed. So in line 26 it says:
* \see t8_forest_vtk.h \see t8_cmesh_vtk.h
This should be changed to \see t8_cmesh_vtk_writer.h/ t8_cmesh_vtk_reader.hxx - dependent on whether both headers should be mentioned or not

The rest looks good

@Davknapp Davknapp assigned chiaraMaHe and unassigned Davknapp and chiaraMaHe Mar 20, 2023
@chiaraMaHe chiaraMaHe assigned Davknapp and unassigned chiaraMaHe Mar 28, 2023
@chiaraMaHe chiaraMaHe merged commit 6a0d91d into main Mar 28, 2023
@chiaraMaHe chiaraMaHe deleted the merge-queue-test branch March 28, 2023 08:51
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