From ab364bc8eb57be8eec7fe2b1c3c959f338daabb6 Mon Sep 17 00:00:00 2001 From: Joseph Torcasso Date: Sun, 26 Jun 2022 20:00:48 -0400 Subject: [PATCH] remove confusing sentence for tags --- docs/docsite/rst/dev_guidelines.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docsite/rst/dev_guidelines.rst b/docs/docsite/rst/dev_guidelines.rst index 2410d2bc986..0caa039f75a 100644 --- a/docs/docsite/rst/dev_guidelines.rst +++ b/docs/docsite/rst/dev_guidelines.rst @@ -540,15 +540,15 @@ should return in the module. As well as information related to the call itself, some response metadata. It is OK to return this to the user as well as they may find it useful. Boto3 commonly returns all keys CamelCased. Ansible follows Python standards for variable names and uses -snake_case. There is a commonly used helper function ``ansible.module_utils.common.dict_transformations.camel_dict_to_snake_dict`` +snake_case. There is a commonly used helper function +``ansible.module_utils.common.dict_transformations.camel_dict_to_snake_dict`` that allows you to easily convert the boto3 response to snake_case. You should use this helper function and avoid changing the names of values returned by Boto3. E.g. if boto3 returns a value called 'SecretAccessKey' do not change it to 'AccessKey'. There is an optional parameter, ``ignore_list``, which is used to avoid converting a sub-tree -of a dict. This is particularly important for tags, where keys are case-sensitive. We -convert the 'Tags' key but nothing below. +of a dict. This is particularly useful for tags, where keys are case-sensitive. .. code-block:: python