From 2b8e2b61f497016c990dbeaf52acdc2c12328e04 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dav=C3=ADd=20Brakenhoff?= Date: Thu, 11 Jul 2024 16:34:39 +0200 Subject: [PATCH] improve docs --- docs/developers.rst | 2 ++ pastas_plugins/responses/rfunc.py | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/developers.rst b/docs/developers.rst index a407eee..591a5e8 100644 --- a/docs/developers.rst +++ b/docs/developers.rst @@ -1,3 +1,5 @@ +.. _Developers: + Developers ========== diff --git a/pastas_plugins/responses/rfunc.py b/pastas_plugins/responses/rfunc.py index 9587594..220d496 100644 --- a/pastas_plugins/responses/rfunc.py +++ b/pastas_plugins/responses/rfunc.py @@ -104,10 +104,12 @@ def theis(A: float, a: float, b: float, t: ArrayLike) -> ArrayLike: def to_dict(self): """Method to export the response function to a dictionary. + Returns ------- data: dict dictionary with all necessary information to reconstruct the rfunc object. + Notes ----- The exported dictionary should exactly match the input arguments of __init__.