diff --git a/docs/api.rst b/docs/api.rst index e515aef7..89b38d0a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -66,12 +66,12 @@ connection class:: Response Filtering ~~~~~~~~~~~~~~~~~~ -The `filter_path` parameter is used to reduce the response returned by -elasticsearch. For example, to only return `_id` and `_type`, do:: +The ``filter_path`` parameter is used to reduce the response returned by +elasticsearch. For example, to only return ``_id`` and ``_type``, do:: es.search(index='test-index', filter_path=['hits.hits._id', 'hits.hits._type']) -It also supports the `*` wildcard character to match any field or part of a +It also supports the ``*`` wildcard character to match any field or part of a field's name:: es.search(index='test-index', filter_path=['hits.hits._*'])