search

firedrakeproject / firedrake

Firedrake is an automated system for the portable solution of partial differential equations using the finite element method (FEM)
https://firedrakeproject.org
Other
520 stars 160 forks source link

Add `__call__` method docstrings to the API documentation #3742

Closed JHopeCollins closed 3 months ago

JHopeCollins commented 3 months ago

Description

By default sphinx doesn't document special (dunder) methods. This PR adds a line to the documentation configuration to include __call__ method docstrings in the API.

It also updates a couple of __call__ docstrings so they build successfully.