Skip to content

Comments

Improved documentation#233

Merged
JoshuaLampert merged 115 commits intoNumericalMathematics:mainfrom
cwittens:improved-documantation
Aug 22, 2025
Merged

Improved documentation#233
JoshuaLampert merged 115 commits intoNumericalMathematics:mainfrom
cwittens:improved-documantation

Conversation

@cwittens
Copy link
Member

@cwittens cwittens commented Jul 30, 2025

This is the current version.
It can be found at: https://cwittens.github.io/DispersiveShallowWater.jl/dev/

It is still missing / has problems with:

  • The chapter https://cwittens.github.io/DispersiveShallowWater.jl/dev/SBP_Operators/#3.-Types-of-SBP-Operators is missing. @JoshuaLampert can you maybe write it? I don't know too much about the various SBP operators, especially Fourier, vs DG vs CG
  • In the Relaxation example, the error growth with and without relaxation is almost the same (maybe the problem is with the analytical solution? because the error is quite large).
  • There is still extra code in make.jl and .github/workflows/Documenter.yml that is needed for compilation in my fork, but it needs to be deleted before merging.

Copy link
Member

@JoshuaLampert JoshuaLampert 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 small point: Could you add a NEWS entry?

ranocha
ranocha previously approved these changes Aug 22, 2025
Copy link
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

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

Thanks a lot! I am fine with this PR once the comments of @JoshuaLampert have been resolved. Feel free to merge when he approves this PR.

Co-authored-by: Joshua Lampert <51029046+JoshuaLampert@users.noreply.github.com>
@JoshuaLampert JoshuaLampert enabled auto-merge (squash) August 22, 2025 11:37
@JoshuaLampert JoshuaLampert merged commit 32b3130 into NumericalMathematics:main Aug 22, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants