Skip to content

Commit 3cac1de

Browse files
jeffwidman88manpreet
authored andcommitted
Minor doc capitalization cleanup
1 parent fec83a9 commit 3cac1de

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

kafka/client_async.py

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -99,26 +99,26 @@ class KafkaClient(object):
9999
brokers or partitions. Default: 300000
100100
security_protocol (str): Protocol used to communicate with brokers.
101101
Valid values are: PLAINTEXT, SSL. Default: PLAINTEXT.
102-
ssl_context (ssl.SSLContext): pre-configured SSLContext for wrapping
102+
ssl_context (ssl.SSLContext): Pre-configured SSLContext for wrapping
103103
socket connections. If provided, all other ssl_* configurations
104104
will be ignored. Default: None.
105-
ssl_check_hostname (bool): flag to configure whether ssl handshake
106-
should verify that the certificate matches the brokers hostname.
107-
default: true.
108-
ssl_cafile (str): optional filename of ca file to use in certificate
109-
veriication. default: none.
110-
ssl_certfile (str): optional filename of file in pem format containing
111-
the client certificate, as well as any ca certificates needed to
112-
establish the certificate's authenticity. default: none.
113-
ssl_keyfile (str): optional filename containing the client private key.
114-
default: none.
115-
ssl_password (str): optional password to be used when loading the
116-
certificate chain. default: none.
117-
ssl_crlfile (str): optional filename containing the CRL to check for
105+
ssl_check_hostname (bool): Flag to configure whether SSL handshake
106+
should verify that the certificate matches the broker's hostname.
107+
Default: True.
108+
ssl_cafile (str): Optional filename of CA file to use in certificate
109+
veriication. Default: None.
110+
ssl_certfile (str): Optional filename of file in PEM format containing
111+
the client certificate, as well as any CA certificates needed to
112+
establish the certificate's authenticity. Default: None.
113+
ssl_keyfile (str): Optional filename containing the client private key.
114+
Default: None.
115+
ssl_password (str): Optional password to be used when loading the
116+
certificate chain. Default: None.
117+
ssl_crlfile (str): Optional filename containing the CRL to check for
118118
certificate expiration. By default, no CRL check is done. When
119119
providing a file, only the leaf certificate will be checked against
120120
this CRL. The CRL can only be checked with Python 3.4+ or 2.7.9+.
121-
default: none.
121+
Default: None.
122122
api_version (tuple): Specify which Kafka API version to use. If set
123123
to None, KafkaClient will attempt to infer the broker version by
124124
probing various APIs. Example: (0, 10, 2). Default: None

0 commit comments

Comments
 (0)