Skip to content

Commit

Permalink
remove confusing sentence for tags
Browse files Browse the repository at this point in the history
  • Loading branch information
jatorcasso committed Jun 27, 2022
1 parent 279f13b commit ab364bc
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/docsite/rst/dev_guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ab364bc

Please sign in to comment.