search

j-fu / VoronoiFVM.jl

Solution of nonlinear multiphysics partial differential equation systems using the Voronoi finite volume method
MIT License
183 stars 33 forks source link

Code comments in examples #3

Open BeastyBlacksmith opened 4 years ago

BeastyBlacksmith commented 4 years ago

The examples need some reformatting, such that the comments inside code (e.g. inside of modules) are not becoming text (cf. https://github.com/fredrikekre/Literate.jl/issues/37). This hurts copy-pasteability a bit.

j-fu commented 4 years ago

It's a matter of taste... Of course you have a point here. OTOH, the way it is done currently allows for better readability of the documentation (once I find time to expand it ...). All the example files are there as Julia sources in the examples directory.
I added the corresponding links below the headers.