From d42768ae9ca27312a9ce287231e28cd6e313acda Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Mon, 11 Sep 2023 11:18:43 +0200 Subject: [PATCH] improve documentation --- tmtccmd/cfdp/request.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tmtccmd/cfdp/request.py b/tmtccmd/cfdp/request.py index aa7b786c..6335e028 100644 --- a/tmtccmd/cfdp/request.py +++ b/tmtccmd/cfdp/request.py @@ -25,9 +25,9 @@ def __init__(self, req_type: CfdpRequestType): @dataclasses.dataclass class PutRequest: """This is the base class modelling put request. You can create this class from the simplified - :py:class:`tmtccmd.config.defs.CfdpParams` class with the - :py:func:`tmtccmd.config.cfdp.cfdp_req_to_put_req_regular` and - :py:func:`tmtccmd.config.cfdp.cfdp_req_to_put_req_proxy_get_req` API.""" + :py:class:`tmtccmd.config.defs.CfdpParams` class with the generic + :py:func:`tmtccmd.config.cfdp.generic_cfdp_params_to_put_request` API and/or all related specific + APIs.""" destination_id: UnsignedByteField # All the following fields are optional because a put request can also be a metadata-only