Skip to content

Commit

Permalink
improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
robamu committed Sep 11, 2023
1 parent cafdb5b commit d42768a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions tmtccmd/cfdp/request.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit d42768a

Please sign in to comment.