From 1cbd87b12347af4be616baf29b2db5a79b0297d0 Mon Sep 17 00:00:00 2001 From: Michael Brewer Date: Mon, 18 Jan 2021 21:47:45 -0800 Subject: [PATCH 1/2] docs(appconfig): Use correct import for docstring --- .../utilities/parameters/appconfig.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/aws_lambda_powertools/utilities/parameters/appconfig.py b/aws_lambda_powertools/utilities/parameters/appconfig.py index ffef7e37e19..6b8c40cac14 100644 --- a/aws_lambda_powertools/utilities/parameters/appconfig.py +++ b/aws_lambda_powertools/utilities/parameters/appconfig.py @@ -32,10 +32,10 @@ class AppConfigProvider(BaseProvider): ------- **Retrieves the latest configuration value from App Config** - >>> from aws_lambda_powertools.utilities.parameters import AppConfigProvider - >>> appconf_provider = parameters.AppConfigProvider(environment="my_env", application="my_app") + >>> from aws_lambda_powertools.utilities import parameters + >>> provider = parameters.AppConfigProvider(environment="my_env", application="my_app") >>> - >>> value : bytes = appconf_provider.get("my_conf") + >>> value : bytes = provider.get("my_conf") >>> >>> print(value) My configuration value @@ -43,12 +43,12 @@ class AppConfigProvider(BaseProvider): **Retrieves a configuration value from App Config in another AWS region** >>> from botocore.config import Config - >>> from aws_lambda_powertools.utilities.parameters import AppConfigProvider + >>> from aws_lambda_powertools.utilities import parameters >>> >>> config = Config(region_name="us-west-1") - >>> appconf_provider = parameters.AppConfigProvider(environment="my_env", application="my_app", config=config) + >>> provider = parameters.AppConfigProvider(environment="my_env", application="my_app", config=config) >>> - >>> value : bytes = appconf_provider.get("my_conf") + >>> value : bytes = provider.get("my_conf") >>> >>> print(value) My configuration value From 08a1dad4a656af6a3c246517b9f0ec9e19f8d355 Mon Sep 17 00:00:00 2001 From: Michael Brewer Date: Wed, 20 Jan 2021 18:14:50 -0800 Subject: [PATCH 2/2] docs: Rename variable back --- aws_lambda_powertools/utilities/parameters/appconfig.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/aws_lambda_powertools/utilities/parameters/appconfig.py b/aws_lambda_powertools/utilities/parameters/appconfig.py index 6b8c40cac14..75840be5e5e 100644 --- a/aws_lambda_powertools/utilities/parameters/appconfig.py +++ b/aws_lambda_powertools/utilities/parameters/appconfig.py @@ -33,9 +33,9 @@ class AppConfigProvider(BaseProvider): **Retrieves the latest configuration value from App Config** >>> from aws_lambda_powertools.utilities import parameters - >>> provider = parameters.AppConfigProvider(environment="my_env", application="my_app") + >>> appconf_provider = parameters.AppConfigProvider(environment="my_env", application="my_app") >>> - >>> value : bytes = provider.get("my_conf") + >>> value : bytes = appconf_provider.get("my_conf") >>> >>> print(value) My configuration value @@ -46,9 +46,9 @@ class AppConfigProvider(BaseProvider): >>> from aws_lambda_powertools.utilities import parameters >>> >>> config = Config(region_name="us-west-1") - >>> provider = parameters.AppConfigProvider(environment="my_env", application="my_app", config=config) + >>> appconf_provider = parameters.AppConfigProvider(environment="my_env", application="my_app", config=config) >>> - >>> value : bytes = provider.get("my_conf") + >>> value : bytes = appconf_provider.get("my_conf") >>> >>> print(value) My configuration value