Skip to content

docs: fix Helmholtz equation rendering and example links - #480

Merged
valeriabarra merged 2 commits into
csrc-sdsu:mainfrom
my6014:docs/fix-helmholtz-example-472
Sep 30, 2026
Merged

valeriabarra merged 2 commits into
csrc-sdsu:mainfrom
my6014:docs/fix-helmholtz-example-472

Conversation

@my6014

@my6014 my6014 commented Sep 27, 2026

Copy link
Copy Markdown
Contributor

What type of PR is this?

  • Documentation

Description

  • Add spacing around display equations so the Helmholtz boundary conditions render as math.
  • Label the Octave and C++ examples by their boundary conditions.
  • Separate the additional variant and Results section from the preceding lists.

Related issue

Closes #472

QA

  • Confirmed all six example links load.
  • Checked the GitHub Markdown preview: both boundary conditions now render as equations.
  • Parsed the page with MyST Parser 3.0.1 and the repository math settings: six display math blocks are recognized, up from three before the change.
  • Documentation only; no runtime tests needed.

@valeriabarra

Copy link
Copy Markdown
Collaborator

Hi @my6014 thank you for your contribution. The improved documentation looks good. Please rebase your branch on the current main branch, since this branch is now out of date with the base branch. Thank you

Separate display equations from surrounding text and label each example by its boundary conditions. Fix spacing before the additional variant and Results section.

Signed-off-by: Ma Yong <1806369472@qq.com>
Signed-off-by: Ma Yong <1806369472@qq.com>
@my6014
my6014 force-pushed the docs/fix-helmholtz-example-472 branch from 87a6ec6 to 05bfb11 Compare September 30, 2026 09:21
@my6014

my6014 commented Sep 30, 2026

Copy link
Copy Markdown
Contributor Author

Thanks! I rebased the PR branch onto the current main branch. The documentation changes and FreeFEM attribution are preserved.

@my6014
my6014 requested a review from valeriabarra September 30, 2026 09:22
@codecov

codecov Bot commented Sep 30, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@valeriabarra
valeriabarra merged commit 154e8fb into csrc-sdsu:main Sep 30, 2026
18 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.

Example documentation improvements

2 participants