ak.str.title
------------

.. py:module: ak.str.title

Defined in `awkward.operations.str.akstr_title <https://github.com/scikit-hep/awkward/blob/36da52cfa8846355c390beb6555eac1d31c27c26/src/awkward/operations/str/akstr_title.py>`__ on `line 13 <https://github.com/scikit-hep/awkward/blob/36da52cfa8846355c390beb6555eac1d31c27c26/src/awkward/operations/str/akstr_title.py#L13>`__.

.. py:function:: ak.str.title(array, *, highlevel=True, behavior=None, attrs=None)


    :param array: Array-like data (anything :py:obj:`ak.to_layout` recognizes).
    :param highlevel: If True, return an :py:obj:`ak.Array`; otherwise, return
                  a low-level :py:obj:`ak.contents.Content` subclass.
    :type highlevel: bool
    :param behavior: Custom :py:obj:`ak.behavior` for the output array, if
                 high-level.
    :type behavior: None or dict
    :param attrs: Custom attributes for the output array, if
              high-level.
    :type attrs: None or dict

Replaces any string-valued data with a titlecase version (correctly
transforming Unicode characters). Each word in the output will start with
an uppercase character and its remaining characters will be lowercase.

Replaces any bytestring-valued data with a titlecase version (transforming
ASCII characters only). Each word in the output will start with an
uppercase character and its remaining characters will be lowercase.

Note: this function does not raise an error if the ``array`` does not
contain any string or bytestring data.

Requires the pyarrow library and calls
`pyarrow.compute.utf8_title <https://arrow.apache.org/docs/python/generated/pyarrow.compute.utf8_title.html>`__
or
`pyarrow.compute.ascii_title <https://arrow.apache.org/docs/python/generated/pyarrow.compute.ascii_title.html>`__
on strings and bytestrings, respectively.