Skip to content

Commit cbc3462

Browse files
committed
refactor(BaseService): improve prepare_request() docstring
This commit simply modifies the docstring comments related to the `headers` and `params` arguments to the `BaseService.prepare_request()` function in order to clarify that any entries in either of the two dictionary arguments will simply be ignored if they have a value of None. Signed-off-by: Phil Adams <[email protected]>
1 parent 37014b5 commit cbc3462

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

ibm_cloud_sdk_core/base_service.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -376,8 +376,10 @@ def prepare_request(
376376
url: The origin + pathname according to WHATWG spec.
377377
378378
Keyword Arguments:
379-
headers: Headers of the request.
380-
params: Querystring data to be appended to the url.
379+
headers: A dictionary containing the headers to be included in the request.
380+
Entries with a value of None will be ignored (excluded).
381+
params: A dictionary containing the query parameters to be included in the request.
382+
Entries with a value of None will be ignored (excluded).
381383
data: The request body. Converted to json if a dict.
382384
files: 'files' can be a dictionary (i.e { '<part-name>': (<tuple>)}),
383385
or a list of tuples [ (<part-name>, (<tuple>))... ]

0 commit comments

Comments
 (0)