Documentation about mtex2gmsh HOT 6 CLOSED

Thank you @streeve for your quick review. All the points you mentioned have been taken into consideration.

Just to mention, the unit test are not that easy to implement on MATLAB. As far as I know, Code Ocean is the easiest way to provide offline test for reproducibility. The link to the related Capsule has been added in README.md.

Considering the API docs, I am not sure to understand its meaning in the MATLAB scripting context. All functions and methods are provided along with help sections (in addition to documentation). For instance, juste type

help gmshGeo

to get help about the gmshGeo constructor.

from mtex2gmsh.

Great, thanks

The Code Ocean online environment is quite nice. My only objection is that (as far as I can tell) it only tests one case. Something like https://github.com/vitorsr/SIHR/blob/master/utils/automated_testing.m could work

from mtex2gmsh.

For the API docs, a section just mentioning both help (thank you, I haven't actively used matlab in a while) and methods to make it easy to explore all options in the class

from mtex2gmsh.

I have added a file named unitTest. It sums up all the examples given in the eponymous folder, plus it plots the geometry in each case.

from mtex2gmsh.

Alternatively, I have update the code on code Ocean, following your recommendations (that is, provide multiple examples).

Tell me if if need to keep the aforementioned unitTest.m or/and the reference to the capsule.

from mtex2gmsh.

I think unitTest.m is exactly what you want: it runs the main examples, is easy to extend, and you can run on Code Ocean or locally

from mtex2gmsh.