Skip to content

Commit a987717

Browse files
committed
Expand docstring
1 parent 82f8c34 commit a987717

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

src/vws/vws.py

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,21 @@ def _make_request(
138138
expected_result_code: str,
139139
) -> Response:
140140
"""
141-
XXX
141+
Make a request to the Vuforia Target API.
142+
143+
This uses `requests` to make a request against https://vws.vuforia.com.
144+
The content type of the request will be `application/json`.
145+
146+
Args:
147+
method: The HTTP method which will be used in the request.
148+
content: The request body which will be used in the request.
149+
request_path: The path to the endpoint which will be used in the
150+
request.
151+
expected_result_code: See
152+
https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API.html#How-To-Interperete-VWS-API-Result-Codes
153+
154+
Returns:
155+
The response to the request made by `requests`.
142156
"""
143157
response = _target_api_request(
144158
server_access_key=self._server_access_key,

0 commit comments

Comments
 (0)