Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 3f2ef20

Browse files
Small fixes to MatrixFederationHttpClient docstrings (#15148)
1 parent f7e49af commit 3f2ef20

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

changelog.d/15148.doc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Correct small documentation errors in some `MatrixFederationHttpClient` methods.

synapse/http/matrixfederationclient.py

+9-7
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ async def _send_request(
440440
Args:
441441
request: details of request to be sent
442442
443-
retry_on_dns_fail: true if the request should be retied on DNS failures
443+
retry_on_dns_fail: true if the request should be retried on DNS failures
444444
445445
timeout: number of milliseconds to wait for the response headers
446446
(including connecting to the server), *for each attempt*.
@@ -475,7 +475,7 @@ async def _send_request(
475475
(except 429).
476476
NotRetryingDestination: If we are not yet ready to retry this
477477
server.
478-
FederationDeniedError: If this destination is not on our
478+
FederationDeniedError: If this destination is not on our
479479
federation whitelist
480480
RequestSendFailed: If there were problems connecting to the
481481
remote, due to e.g. DNS failures, connection timeouts etc.
@@ -871,7 +871,7 @@ async def put_json(
871871
(except 429).
872872
NotRetryingDestination: If we are not yet ready to retry this
873873
server.
874-
FederationDeniedError: If this destination is not on our
874+
FederationDeniedError: If this destination is not on our
875875
federation whitelist
876876
RequestSendFailed: If there were problems connecting to the
877877
remote, due to e.g. DNS failures, connection timeouts etc.
@@ -958,7 +958,7 @@ async def post_json(
958958
(except 429).
959959
NotRetryingDestination: If we are not yet ready to retry this
960960
server.
961-
FederationDeniedError: If this destination is not on our
961+
FederationDeniedError: If this destination is not on our
962962
federation whitelist
963963
RequestSendFailed: If there were problems connecting to the
964964
remote, due to e.g. DNS failures, connection timeouts etc.
@@ -1036,6 +1036,8 @@ async def get_json(
10361036
args: A dictionary used to create query strings, defaults to
10371037
None.
10381038
1039+
retry_on_dns_fail: true if the request should be retried on DNS failures
1040+
10391041
timeout: number of milliseconds to wait for the response.
10401042
self._default_timeout (60s) by default.
10411043
@@ -1063,7 +1065,7 @@ async def get_json(
10631065
(except 429).
10641066
NotRetryingDestination: If we are not yet ready to retry this
10651067
server.
1066-
FederationDeniedError: If this destination is not on our
1068+
FederationDeniedError: If this destination is not on our
10671069
federation whitelist
10681070
RequestSendFailed: If there were problems connecting to the
10691071
remote, due to e.g. DNS failures, connection timeouts etc.
@@ -1141,7 +1143,7 @@ async def delete_json(
11411143
(except 429).
11421144
NotRetryingDestination: If we are not yet ready to retry this
11431145
server.
1144-
FederationDeniedError: If this destination is not on our
1146+
FederationDeniedError: If this destination is not on our
11451147
federation whitelist
11461148
RequestSendFailed: If there were problems connecting to the
11471149
remote, due to e.g. DNS failures, connection timeouts etc.
@@ -1197,7 +1199,7 @@ async def get_file(
11971199
(except 429).
11981200
NotRetryingDestination: If we are not yet ready to retry this
11991201
server.
1200-
FederationDeniedError: If this destination is not on our
1202+
FederationDeniedError: If this destination is not on our
12011203
federation whitelist
12021204
RequestSendFailed: If there were problems connecting to the
12031205
remote, due to e.g. DNS failures, connection timeouts etc.

0 commit comments

Comments
 (0)