Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Include references to papers developing the discretizations in the docs #125

Closed
ranocha opened this issue Aug 7, 2024 · 1 comment · Fixed by #128
Closed

Include references to papers developing the discretizations in the docs #125

ranocha opened this issue Aug 7, 2024 · 1 comment · Fixed by #128
Labels
documentation Improvements or additions to documentation

Comments

@ranocha
Copy link
Collaborator

ranocha commented Aug 7, 2024

Would it make sense to include references to papers developing the structure-preserving (semi-) discretizations in the docstrings of the equations as well? Right now, they contain only basic references to the papers developing the models.
@ranocha ranocha added the documentation Improvements or additions to documentation label Aug 7, 2024
@JoshuaLampert JoshuaLampert mentioned this issue Aug 8, 2024
Merged
@JoshuaLampert
Copy link
Owner

Makes sense, I think. See #128.

# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add references to semidiscretizations in docstrings JoshuaLampert/DispersiveShallowWater.jl
2 participants
@ranocha @JoshuaLampert