OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

Small fixes to `MatrixFederationHttpClient` docstrings (#15148)

pull/13083/head
Andrew Morgan 2023-02-27 13:03:22 +00:00 committed by GitHub
parent f7e49afb99
commit 3f2ef205e2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/15148.doc Normal file
View File

@ -0,0 +1 @@
Correct small documentation errors in some `MatrixFederationHttpClient` methods.

16
synapse/http/matrixfederationclient.py
View File

@ -440,7 +440,7 @@ class MatrixFederationHttpClient:
Args: Args:
request: details of request to be sent 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 timeout: number of milliseconds to wait for the response headers
(including connecting to the server), *for each attempt*. (including connecting to the server), *for each attempt*.
@ -475,7 +475,7 @@ class MatrixFederationHttpClient:
(except 429). (except 429).
NotRetryingDestination: If we are not yet ready to retry this NotRetryingDestination: If we are not yet ready to retry this
server. server.
FederationDeniedError: If this destination is not on our FederationDeniedError: If this destination is not on our
federation whitelist federation whitelist
RequestSendFailed: If there were problems connecting to the RequestSendFailed: If there were problems connecting to the
remote, due to e.g. DNS failures, connection timeouts etc. remote, due to e.g. DNS failures, connection timeouts etc.
@ -871,7 +871,7 @@ class MatrixFederationHttpClient:
(except 429). (except 429).
NotRetryingDestination: If we are not yet ready to retry this NotRetryingDestination: If we are not yet ready to retry this
server. server.
FederationDeniedError: If this destination is not on our FederationDeniedError: If this destination is not on our
federation whitelist federation whitelist
RequestSendFailed: If there were problems connecting to the RequestSendFailed: If there were problems connecting to the
remote, due to e.g. DNS failures, connection timeouts etc. remote, due to e.g. DNS failures, connection timeouts etc.
@ -958,7 +958,7 @@ class MatrixFederationHttpClient:
(except 429). (except 429).
NotRetryingDestination: If we are not yet ready to retry this NotRetryingDestination: If we are not yet ready to retry this
server. server.
FederationDeniedError: If this destination is not on our FederationDeniedError: If this destination is not on our
federation whitelist federation whitelist
RequestSendFailed: If there were problems connecting to the RequestSendFailed: If there were problems connecting to the
remote, due to e.g. DNS failures, connection timeouts etc. remote, due to e.g. DNS failures, connection timeouts etc.
@ -1036,6 +1036,8 @@ class MatrixFederationHttpClient:
args: A dictionary used to create query strings, defaults to args: A dictionary used to create query strings, defaults to
None. None.
retry_on_dns_fail: true if the request should be retried on DNS failures
timeout: number of milliseconds to wait for the response. timeout: number of milliseconds to wait for the response.
self._default_timeout (60s) by default. self._default_timeout (60s) by default.
@ -1063,7 +1065,7 @@ class MatrixFederationHttpClient:
(except 429). (except 429).
NotRetryingDestination: If we are not yet ready to retry this NotRetryingDestination: If we are not yet ready to retry this
server. server.
FederationDeniedError: If this destination is not on our FederationDeniedError: If this destination is not on our
federation whitelist federation whitelist
RequestSendFailed: If there were problems connecting to the RequestSendFailed: If there were problems connecting to the
remote, due to e.g. DNS failures, connection timeouts etc. remote, due to e.g. DNS failures, connection timeouts etc.
@ -1141,7 +1143,7 @@ class MatrixFederationHttpClient:
(except 429). (except 429).
NotRetryingDestination: If we are not yet ready to retry this NotRetryingDestination: If we are not yet ready to retry this
server. server.
FederationDeniedError: If this destination is not on our FederationDeniedError: If this destination is not on our
federation whitelist federation whitelist
RequestSendFailed: If there were problems connecting to the RequestSendFailed: If there were problems connecting to the
remote, due to e.g. DNS failures, connection timeouts etc. remote, due to e.g. DNS failures, connection timeouts etc.
@ -1197,7 +1199,7 @@ class MatrixFederationHttpClient:
(except 429). (except 429).
NotRetryingDestination: If we are not yet ready to retry this NotRetryingDestination: If we are not yet ready to retry this
server. server.
FederationDeniedError: If this destination is not on our FederationDeniedError: If this destination is not on our
federation whitelist federation whitelist
RequestSendFailed: If there were problems connecting to the RequestSendFailed: If there were problems connecting to the
remote, due to e.g. DNS failures, connection timeouts etc. remote, due to e.g. DNS failures, connection timeouts etc.