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

Small fixes to MatrixFederationHttpClient docstrings #15148

Merged
merged 2 commits into from
Feb 27, 2023
Merged

Small fixes to MatrixFederationHttpClient docstrings #15148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39925fa
Small fixes to MatrixFederationHttpClient docstrings
anoadragon453 Feb 23, 2023
b644574
changelog
anoadragon453 Feb 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/15148.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Correct small documentation errors in some `MatrixFederationHttpClient` methods.
16 changes: 9 additions & 7 deletions synapse/http/matrixfederationclient.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,7 +440,7 @@ async def _send_request(
Args:
request: details of request to be sent

retry_on_dns_fail: true if the request should be retied on DNS failures
retry_on_dns_fail: true if the request should be retried on DNS failures

timeout: number of milliseconds to wait for the response headers
(including connecting to the server), *for each attempt*.
Expand Down Expand Up @@ -475,7 +475,7 @@ async def _send_request(
(except 429).
NotRetryingDestination: If we are not yet ready to retry this
server.
FederationDeniedError: If this destination is not on our
FederationDeniedError: If this destination is not on our
federation whitelist
RequestSendFailed: If there were problems connecting to the
remote, due to e.g. DNS failures, connection timeouts etc.
Expand Down Expand Up @@ -871,7 +871,7 @@ async def put_json(
(except 429).
NotRetryingDestination: If we are not yet ready to retry this
server.
FederationDeniedError: If this destination is not on our
FederationDeniedError: If this destination is not on our
federation whitelist
RequestSendFailed: If there were problems connecting to the
remote, due to e.g. DNS failures, connection timeouts etc.
Expand Down Expand Up @@ -958,7 +958,7 @@ async def post_json(
(except 429).
NotRetryingDestination: If we are not yet ready to retry this
server.
FederationDeniedError: If this destination is not on our
FederationDeniedError: If this destination is not on our
federation whitelist
RequestSendFailed: If there were problems connecting to the
remote, due to e.g. DNS failures, connection timeouts etc.
Expand Down Expand Up @@ -1036,6 +1036,8 @@ async def get_json(
args: A dictionary used to create query strings, defaults to
None.

retry_on_dns_fail: true if the request should be retried on DNS failures

timeout: number of milliseconds to wait for the response.
self._default_timeout (60s) by default.

Expand Down Expand Up @@ -1063,7 +1065,7 @@ async def get_json(
(except 429).
NotRetryingDestination: If we are not yet ready to retry this
server.
FederationDeniedError: If this destination is not on our
FederationDeniedError: If this destination is not on our
federation whitelist
RequestSendFailed: If there were problems connecting to the
remote, due to e.g. DNS failures, connection timeouts etc.
Expand Down Expand Up @@ -1141,7 +1143,7 @@ async def delete_json(
(except 429).
NotRetryingDestination: If we are not yet ready to retry this
server.
FederationDeniedError: If this destination is not on our
FederationDeniedError: If this destination is not on our
federation whitelist
RequestSendFailed: If there were problems connecting to the
remote, due to e.g. DNS failures, connection timeouts etc.
Expand Down Expand Up @@ -1197,7 +1199,7 @@ async def get_file(
(except 429).
NotRetryingDestination: If we are not yet ready to retry this
server.
FederationDeniedError: If this destination is not on our
FederationDeniedError: If this destination is not on our
federation whitelist
RequestSendFailed: If there were problems connecting to the
remote, due to e.g. DNS failures, connection timeouts etc.
Expand Down