Repository: boto/boto3
File: boto3/docs/action.py (Python)

Code before:
from boto3.docs.utils import (
    add_resource_type_overview,
    get_resource_ignore_params,
    get_resource_public_actions,
)

WARNING_MESSAGE_TEMPLATE = """
.. warning::
    Please note that this method does not function as expected. It is
    recommended to use the :py:meth:`{suggested_py_method_name}`
    :doc:`client method <{suggested_py_method_rel_path}>` instead.
    {extra}
"""
DOCUMENT_ACTION_OVERRIDES = {
    "Metric": {
        "put_data": {
            "ignore_params": ["Namespace"],
            "warning": WARNING_MESSAGE_TEMPLATE.format(
                suggested_py_method_name="put_metric_data",
                suggested_py_method_rel_path=(
                    "../../cloudwatch/client/put_metric_data"
                ),
                extra=(
                    "If you would still like to use this method, please make sure "
                    "that `MetricData[].MetricName` is equal to the metric resource's "
                    "`name` attribute."
                ),
            ),
        }
    }
}


class ActionDocumenter(NestedDocumenter):
    def document_actions(self, section):
        modeled_actions_list = self._resource_model.actions
        modeled_actions = {}
        for modeled_action in modeled_actions_list:
            modeled_actions[modeled_action.name] = modeled_action
        resource_actions = get_resource_public_actions(
            self._resource.__class__
        )
        self.member_map['actions'] = sorted(resource_actions)
        add_resource_type_overview(
            section=section,
            resource_type='Actions',
            description=(
                'Actions call operations on resources.  They may '
                'automatically handle the passing in of arguments set '
                'from identifiers and some attributes.'
            ),

Review comment (suggestion):
Im assuming you might have wanted these to be inline-code instead of italicized. In restructuredText this is done by using ``` `` ``` instead of ``` ` ``` like in markdown. 
Source: [Sphinx Website](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#:~:text=backquotes%3A%20%60%60text%60%60%20for%20code%20samples.)

So:
* ``` `MetricData[].MetricName` ``` --> ``` ``MetricData[].MetricName`` ```
* ``` `name` ``` --> ``` ``name`` ```

Code after:
from boto3.docs.utils import (
    add_resource_type_overview,
    get_resource_ignore_params,
    get_resource_public_actions,
)

PUT_DATA_WARNING_MESSAGE = """
.. warning::
    It is recommended to use the :py:meth:`put_metric_data`
    :doc:`client method <../../cloudwatch/client/put_metric_data>`
    instead. If you would still like to use this resource method,
    please make sure that ``MetricData[].MetricName`` is equal to
    the metric resource's ``name`` attribute.
"""

WARNING_MESSAGES = {
    "Metric": {"put_data": PUT_DATA_WARNING_MESSAGE},
}

IGNORE_PARAMS = {"Metric": {"put_data": ["Namespace"]}}


class ActionDocumenter(NestedDocumenter):
    def document_actions(self, section):
        modeled_actions_list = self._resource_model.actions
        modeled_actions = {}
        for modeled_action in modeled_actions_list:
            modeled_actions[modeled_action.name] = modeled_action
        resource_actions = get_resource_public_actions(
            self._resource.__class__
        )
        self.member_map['actions'] = sorted(resource_actions)
        add_resource_type_overview(
            section=section,
            resource_type='Actions',
            description=(
                'Actions call operations on resources.  They may '
                'automatically handle the passing in of arguments set '
                'from identifiers and some attributes.'
            ),
            intro_link='actions_intro',
        )
        resource_warnings = WARNING_MESSAGES.get(self._resource_name, {})
        for action_name in sorted(resource_actions):
            # Create a new DocumentStructure for each action and add contents.
            action_doc = DocumentStructure(action_name, target='html')
            breadcrumb_section = action_doc.add_new_section('breadcrumb')
            breadcrumb_section.style.ref(self._resource_class_name, 'index')
            breadcrumb_section.write(f' / Action / {action_name}')
            action_doc.add_title_section(action_name)
            warning_message = resource_warnings.get(action_name)