Revise docstring of convert case styles methods

Revise docstring of convert_camelcase_to_snakecase() method and
convert_snakecase_to_camelcase() method to make it clear about the
behavior.

Change-Id: I3ea50426dc3c873d7b73553dab4b10cef52535c8
Closes-Bug: #1890078
This commit is contained in:
ueha.ayumu 2020-08-07 02:10:25 +00:00
parent 390b659a65
commit ef7bc61632
1 changed files with 6 additions and 0 deletions

View File

@ -340,6 +340,9 @@ def convert_camelcase_to_snakecase(request_data):
"""Converts dict keys or list of dict keys from camelCase to snake_case.
Returns a dict with keys or list with dict keys, in snake_case.
This method takes care only keys in a `dict` or `dicts in a list`.
For simple list with string items, the elements which are actual values
are ignored during conversion.
:param request_data: dict with keys or list with items, in camelCase.
"""
@ -371,6 +374,9 @@ def convert_snakecase_to_camelcase(request_data):
"""Converts dict keys or list of dict keys from snake_case to camelCase.
Returns a dict with keys or list with dict key, in camelCase.
This method takes care only keys in a `dict` or `dicts in a list`.
For simple list with string items, the elements which are actual values
are ignored during conversion.
:param request_data: dict with keys or list with items, in snake_case.
"""