diff --git a/pandas/_libs/tslibs/period.pyx b/pandas/_libs/tslibs/period.pyx index 0c05037097839..8fccd3541fde1 100644 --- a/pandas/_libs/tslibs/period.pyx +++ b/pandas/_libs/tslibs/period.pyx @@ -2483,9 +2483,11 @@ class Period(_Period): Parameters ---------- value : Period or str, default None - The time period represented (e.g., '4Q2005'). + The time period represented (e.g., '4Q2005'). This represents neither + the start or the end of the period, but rather the entire period itself. freq : str, default None - One of pandas period strings or corresponding objects. + One of pandas period strings or corresponding objects. Accepted + strings are listed in the :ref:`offset alias section ` in the user docs. ordinal : int, default None The period offset from the proleptic Gregorian epoch. year : int, default None @@ -2502,6 +2504,12 @@ class Period(_Period): Minute value of the period. second : int, default 0 Second value of the period. + + Examples + -------- + >>> period = pd.Period('2012-1-1', freq='D') + >>> period + Period('2012-01-01', 'D') """ def __new__(cls, value=None, freq=None, ordinal=None,