From fdba76455bfeb91ec349201e396e9840ddda2f90 Mon Sep 17 00:00:00 2001 From: Denis Otkidach Date: Sun, 26 Nov 2023 22:19:03 +0200 Subject: [PATCH] Fix docstrings --- aiokafka/consumer/consumer.py | 2 +- aiokafka/producer/producer.py | 3 +-- docs/api.rst | 4 +--- 3 files changed, 3 insertions(+), 6 deletions(-) diff --git a/aiokafka/consumer/consumer.py b/aiokafka/consumer/consumer.py index 8b58fb4a..aba21b9b 100644 --- a/aiokafka/consumer/consumer.py +++ b/aiokafka/consumer/consumer.py @@ -213,7 +213,7 @@ class AIOKafkaConsumer: sasl_plain_password (str): password for SASL ``PLAIN`` authentication. Default: None sasl_oauth_token_provider (~aiokafka.abc.AbstractTokenProvider): - OAuthBearer token provider instance. (See :mod:`aiokafka.oauth`). + OAuthBearer token provider instance. Default: None Note: diff --git a/aiokafka/producer/producer.py b/aiokafka/producer/producer.py index 3c5a096e..ea9fdbe0 100644 --- a/aiokafka/producer/producer.py +++ b/aiokafka/producer/producer.py @@ -165,8 +165,7 @@ class AIOKafkaProducer: sasl_plain_password (str): password for SASL ``PLAIN`` authentication. Default: :data:`None` sasl_oauth_token_provider (:class:`~aiokafka.abc.AbstractTokenProvider`): - OAuthBearer token provider instance. (See - :mod:`aiokafka.oauth`). + OAuthBearer token provider instance. Default: :data:`None` Note: diff --git a/docs/api.rst b/docs/api.rst index 9ca4f590..6455acac 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -80,9 +80,7 @@ and ``GSSAPI`` SASL methods. Be sure to install `gssapi`_ python module to use Please consult the `official documentation `__ for setup instructions on Broker side. Client configuration is pretty much the same as Java's, consult the ``sasl_*`` options in Consumer and Producer API -Reference for more details. - -.. automodule:: aiokafka.oauth +Reference for more details. See :class:`~aiokafka.abc.AbstractTokenProvider`. Error handling