Skip to content

#244 Ensure function headings match filenames - #253

Merged
bencox merged 1 commit into
ucl-bug:developfrom
parfenovma:244-fix-function-headings
Sep 1, 2026
Merged

bencox merged 1 commit into
ucl-bug:developfrom
parfenovma:244-fix-function-headings

Conversation

@parfenovma

@parfenovma parfenovma commented Aug 18, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Updates the function headings in 40 MATLAB files so that each heading matches the corresponding filename.
  • These are documentation-only changes; no executable code or behaviour has been changed.

Testing

  • No runtime tests were required because only comment headings were changed.
  • The diff was checked to ensure that each updated heading matches its filename.

Related Issues

Closes #244

Contributor Agreement

  • By submitting this pull request, I confirm I have read the Legal and Licensing section in CONTRIBUTING.md, and I agree that my contributions may be redistributed under the k-Wave-II open-source license.

Peer Review

Review summary (complete before merge):

  • New (unit) test/s implemented — not applicable
  • All (unit) test/s pass
  • New code is documented — documentation-only change
  • Documentation builds and looks right
  • Examples/Tutorials added — not applicable
  • Linting tests pass
  • Code review:
    • Implementation is sensible
    • Code meets coding standard
    • Issue description is complete

@bencox bencox left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Great, thanks for doing that.

@bencox
bencox merged commit 8545153 into ucl-bug:develop Sep 1, 2026
3 of 6 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.

Ensure function names are at the top of files

2 participants