search

OrchardLANL / DPFEHM.jl

DPFEHM: A Differentiable Subsurface Flow Simulator
Other
30 stars 13 forks source link

document examples #14

Closed WilkAndy closed 2 years ago

WilkAndy commented 2 years ago

Apart from 2 examples, non of them seem to be documented. Just a few lines of in-code documentation to explain what the example does would be really useful to readers.

WilkAndy commented 2 years ago

Refs https://github.com/openjournals/joss-reviews/issues/4560

omalled commented 2 years ago

Alright, I added some comments at the top of all the examples giving a basic explanation.