Skip to content

Commit 296cbda

Browse files
authored
DOC: improve Timestamp properties docstrings (pandas-dev#50619)
1 parent f4136c0 commit 296cbda

File tree

1 file changed

+42
-4
lines changed

1 file changed

+42
-4
lines changed

pandas/_libs/tslibs/timestamps.pyx

+42-4
Original file line numberDiff line numberDiff line change
@@ -579,7 +579,16 @@ cdef class _Timestamp(ABCTimestamp):
579579
@property
580580
def is_month_start(self) -> bool:
581581
"""
582-
Return True if date is first day of month.
582+
Check if the date is the first day of the month.
583+
584+
Returns
585+
-------
586+
bool
587+
True if the date is the first day of the month.
588+
589+
See Also
590+
--------
591+
Timestamp.is_month_end : Similar property indicating the last day of the month.
583592

584593
Examples
585594
--------
@@ -596,7 +605,16 @@ cdef class _Timestamp(ABCTimestamp):
596605
@property
597606
def is_month_end(self) -> bool:
598607
"""
599-
Return True if date is last day of month.
608+
Check if the date is the last day of the month.
609+
610+
Returns
611+
-------
612+
bool
613+
True if the date is the last day of the month.
614+
615+
See Also
616+
--------
617+
Timestamp.is_month_start : Similar property indicating month start.
600618

601619
Examples
602620
--------
@@ -613,7 +631,17 @@ cdef class _Timestamp(ABCTimestamp):
613631
@property
614632
def is_quarter_start(self) -> bool:
615633
"""
616-
Return True if date is first day of the quarter.
634+
Check if the date is the first day of the quarter.
635+
636+
Returns
637+
-------
638+
bool
639+
True if date is first day of the quarter.
640+
641+
See Also
642+
--------
643+
Timestamp.is_quarter_end : Similar property indicating the quarter end.
644+
Timestamp.quarter : Return the quarter of the date.
617645

618646
Examples
619647
--------
@@ -630,7 +658,17 @@ cdef class _Timestamp(ABCTimestamp):
630658
@property
631659
def is_quarter_end(self) -> bool:
632660
"""
633-
Return True if date is last day of the quarter.
661+
Check if date is last day of the quarter.
662+
663+
Returns
664+
-------
665+
bool
666+
True if date is last day of the quarter.
667+
668+
See Also
669+
--------
670+
Timestamp.is_quarter_start : Similar property indicating the quarter start.
671+
Timestamp.quarter : Return the quarter of the date.
634672

635673
Examples
636674
--------

0 commit comments

Comments
 (0)