Put argument types in docstrings rather than using hints

mesh-adaptation / goalie

Goal-oriented error estimation and mesh adaptation for finite element problems solved using Firedrake

Other

1 stars 1 forks source link

Closed jwallwork23 closed 4 months ago

jwallwork23 commented 4 months ago

Much of Goalie currently uses Python type hints. These are okay when the user is perusing source code but have several downsides:

They aren't in the docstrings and so don't appear in the API documentation.
They often require additional imports.
They often make the number of characters longer than the maximum line length, leading to multi-line statements and reduced readability.