Skip to content

Improve the documentation of grid-functions

Simon Praetorius requested to merge issue/improve-documentation-of-gridfunction into master

Summary

This MR improves the documentation of several classes in the directory gridfunctions/.

TODO

  • Check proper documentation of pre-conditions (and post-conditions) in, e.g., the bind() methods
  • Check whether all grid-functions have a detection of "bound" when evaluating local-functions
  • Squash commits
  • Extract code changes to separate MRs

Proper documentation of pre-conditions in derivative() functions, requires a resolution of issue #69 (closed).

Edited by Simon Praetorius

Merge request reports