Compile better C++ docstring
To better understand what the generated forms actually do, it would be great if the C++ header files (or more specifically the generated classes) get better docstrings. The content would need to be collected during the generation from various places. Some of this is already being collected.
-
the form function should provide info about what the integrand looks like (see terraneo/hyteg-form-generator!70) -
the quadrature degree should be available -
the geometry map should be explained -
the optimizations should be listed -
a HFG commit/version would be nice to have -
the flop tables per element (if still valid) -
general docstrings for the constructor -
what is and is not communicated
Some remaining issues:
-
if the docstrings for the form depend on the element, then we currently add it twice -
same issue for quadrature rules, we need to summarize that to not bloat the docstring too much
Edited by Fabian Böhm