From a1eb0b8e2803b75911ca47f198555b965ca841b4 Mon Sep 17 00:00:00 2001 From: Tim Gates Date: Thu, 14 Jul 2022 17:59:43 +1000 Subject: [PATCH] docs: Fix a few typos There are small typos in: - examples/django/proj/settings.py - faust/transport/drivers/aiokafka.py - faust/types/settings/params.py - faust/types/settings/settings.py Fixes: - Should read `ridiculously` rather than `ridiculuously`. - Should read `environment` rather than `environent`. - Should read `enqueuing` rather than `enqueing`. - Should read `description` rather than `desscription`. --- examples/django/proj/settings.py | 2 +- faust/transport/drivers/aiokafka.py | 2 +- faust/types/settings/params.py | 2 +- faust/types/settings/settings.py | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/django/proj/settings.py b/examples/django/proj/settings.py index 812816d24..964c7e697 100644 --- a/examples/django/proj/settings.py +++ b/examples/django/proj/settings.py @@ -93,7 +93,7 @@ AUTH_PASSWORD_VALIDATORS = [ { - 'NAME': ( # ridiculuously long names are silly + 'NAME': ( # ridiculously long names are silly 'django.contrib.auth.password_validation.' 'UserAttributeSimilarityValidator'), }, diff --git a/faust/transport/drivers/aiokafka.py b/faust/transport/drivers/aiokafka.py index c0ab96dfe..80d5c4ab7 100644 --- a/faust/transport/drivers/aiokafka.py +++ b/faust/transport/drivers/aiokafka.py @@ -802,7 +802,7 @@ async def getmany(self, """Fetch batch of messages from server.""" # Implementation for the Fetcher service. _consumer = self._ensure_consumer() - # NOTE: Since we are enqueing the fetch request, + # NOTE: Since we are enqueuing the fetch request, # we need to check when dequeued that we are not in a rebalancing # state at that point to return early, or we # will create a deadlock (fetch request starts after flow stopped) diff --git a/faust/types/settings/params.py b/faust/types/settings/params.py index 883a26cf4..5ed295ba9 100644 --- a/faust/types/settings/params.py +++ b/faust/types/settings/params.py @@ -130,7 +130,7 @@ def to_bool(term: Union[str, bool], *, class Param(Generic[IT, OT], property): - """Faust setting desscription. + """Faust setting description. Describes a Faust setting, how to read it from environment variables or from a configuration object. diff --git a/faust/types/settings/settings.py b/faust/types/settings/settings.py index 1b37c55b0..72efdb275 100644 --- a/faust/types/settings/settings.py +++ b/faust/types/settings/settings.py @@ -480,7 +480,7 @@ def debug(self) -> bool: def env_prefix(self) -> str: """Environment variable prefix. - When configuring Faust by environent variables, + When configuring Faust by environment variables, this adds a common prefix to all Faust environment value names. """