mesh-adaptation / goalie

Goal-oriented error estimation and mesh adaptation for finite element problems solved using Firedrake
Other
2 stars 0 forks source link

Purge typehints; mention type in docstrings #134

Closed jwallwork23 closed 8 months ago

jwallwork23 commented 8 months ago

Closes #121, Closes #127.

It is better practice to mention the types of arguments and return values in the docstring, rather than using type hints. Doing so ensures that this information ends up in the docs. (The metric module is not addressed because it is covered in #56.)

This PR also:

Would you mind reviewing this @acse-ej321? Apologies that it is somewhat long and boring.

jwallwork23 commented 8 months ago

Thanks very much for reviewing this, @acse-ej321! Good suggestions.

jwallwork23 commented 8 months ago

Great, thanks again for reviewing this!