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

add documentation for t8_forest_leaf_face_neighbors_ext #1269

Merged
merged 11 commits into from
Oct 16, 2024

Conversation

ole-alb
Copy link
Contributor

@ole-alb ole-alb commented Oct 15, 2024

Describe your changes here:
Add documentation for t8_forest_leaf_face_neighbors_ext.

Closes #1264

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.

License

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

@ole-alb ole-alb added priority: low Should be solved eventually workload: low Would take half a day or less Bug For a bug in the Code documentation and removed Bug For a bug in the Code labels Oct 15, 2024
Copy link
Collaborator

@holke holke left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!
Just some minor changes.

src/t8_forest/t8_forest_general.h Outdated Show resolved Hide resolved
src/t8_forest/t8_forest_general.h Outdated Show resolved Hide resolved
@ole-alb ole-alb requested a review from holke October 16, 2024 13:17
@holke holke assigned holke and unassigned ole-alb Oct 16, 2024
@holke holke enabled auto-merge October 16, 2024 13:34
@holke holke merged commit e29ab27 into main Oct 16, 2024
27 checks passed
@holke holke deleted the Document-t8_forest_leaf_face_neighbors_ext branch October 16, 2024 14:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation priority: low Should be solved eventually workload: low Would take half a day or less
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document t8_forest_leaf_face_neighbors_ext
2 participants