Skip to content

expand fine_patch documentation to cover both possible levels#1348

Merged
AlexanderSinn merged 6 commits intoHi-PACE:developmentfrom
MarcelHoh:fix/1347_improve_documentation_of_fine_patch
Jan 29, 2026
Merged

expand fine_patch documentation to cover both possible levels#1348
AlexanderSinn merged 6 commits intoHi-PACE:developmentfrom
MarcelHoh:fix/1347_improve_documentation_of_fine_patch

Conversation

@MarcelHoh
Copy link
Copy Markdown
Contributor

  • [✅ ] Small enough (< few 100s of lines), otherwise it should probably be split into smaller PRs
  • [✅ ] Tested - See below screenshot of built documentation
  • [not relevant ] Runs on GPU (basic: the code compiles and run well with the new module)
  • [not relevant ] Contains an automated test (checksum and/or comparison with theory)
  • [✅ ] Documented: all elements (classes and their members, functions, namespaces, etc.) are documented
  • [not relevant ] Constified (All that can be const is const)
  • [✅ ] Code is clean (no unwanted comments, )
  • [✅ ] Style and code conventions are respected at the bottom of https://github.com/Hi-PACE/hipace
  • [✅ ] Proper label and GitHub project, if applicable
image

Any comments on the wording are very welcome.

@AlexanderSinn
Copy link
Copy Markdown
Member

Some of the CI tests fail for an unrelated reason; it should be fixed soon.

@AlexanderSinn
Copy link
Copy Markdown
Member

Can you merge development into this branch. That should fix the CI tests

Copy link
Copy Markdown
Member

@AlexanderSinn AlexanderSinn 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 this PR!

@AlexanderSinn AlexanderSinn merged commit 42a8bbe into Hi-PACE:development Jan 29, 2026
11 checks passed
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.

Documentation suggests only one level of fine_patch is supported, when two are.

2 participants