Skip to content
This repository was archived by the owner on Feb 2, 2024. It is now read-only.
Prev Previous commit
Next Next commit
Add docs with categorical limitations.
  • Loading branch information
PokhodenkoSA committed May 15, 2020
commit db71a3dc7a9633349e0e5dbaf5a7b626e62eed9b
7 changes: 7 additions & 0 deletions sdc/hiframes/pd_series_ext.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,13 +111,20 @@ def pd_series_overload(data=None, index=None, dtype=None, name=None, copy=False,
-----------
- Parameters ``dtype`` and ``copy`` are currently unsupported.
- Types iterable and dict as ``data`` parameter are currently unsupported.
- Categorical types (i.e. 'category' and ``CategoricalDtype``) are supported in ``dtype``
only if they are provided as constants in jitted code.

Examples
--------
Create Series with data [1, 2, 3] and index ['A', 'B', 'C'].

>>> pd.Series([1, 2, 3], ['A', 'B', 'C'])

Create Series with categorical data:

>>> pd.Series([1, 2, 3], dtype='category')
>>> pd.Series([1, 2, 3], dtype=CategoricalDtype([1, 2, 3]))

.. seealso::

:ref:`DataFrame <pandas.DataFrame>`
Expand Down