Skip to content
This repository was archived by the owner on Mar 18, 2019. It is now read-only.

Commit 7db1aed

Browse files
committed
Update transport docs to add 'auth', and deprecate 'credentials'
1 parent 9b83d2d commit 7db1aed

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/api-guide/transports.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ The `HTTPTransport` class supports the `http` and `https` schemes.
1818

1919
#### Instantiation
2020

21-
**Signature**: `HTTPTransport(credentials=None, headers=None, session=None)`
21+
**Signature**: `HTTPTransport(auth=None, headers=None, session=None)`
2222

23-
* `credentials` - A dictionary of items that maps domain name to values that should be used in the request `Authorization` header for each domain.
23+
* `auth` - An authentication instance, or None.
2424
* `headers` - A dictionary of items that should be included in the outgoing request headers.
2525
* `session` - A [requests session instance][sessions] to use when sending requests. This can be used to further customize how HTTP requests and responses are handled, for instance by allowing [transport adapters][transport-adapters] to be attached to the underlying session.
2626

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy