File tree Expand file tree Collapse file tree 1 file changed +16
-0
lines changed
Expand file tree Collapse file tree 1 file changed +16
-0
lines changed Original file line number Diff line number Diff line change @@ -43,6 +43,22 @@ class GeoComResponse(Generic[_P]):
4343 """
4444 Container class for parsed GeoCom responses.
4545
46+ The response encapsulates the original command, that was sent, and the
47+ response received, as well as the codes and parameters extracted from
48+ the response.
49+
50+ The `params` usually takes 3 types of values:
51+
52+ - **None**: the response explicitly returned no values
53+ - **Scalar**: the response returned a single parameter
54+ - **Sequence** (usually a `tuple`): the response returned multiple
55+ parameters
56+
57+ Warning
58+ -------
59+ The `params` will be also `None`, if the parameter parsing failed for
60+ some reason, to signal the unsuccessful operation. This error case must
61+ be handled before using the returned values.
4662 """
4763
4864 def __init__ (
You can’t perform that action at this time.
0 commit comments