Skip to content

Commit 638254f

Browse files
tuhinsharma121tuhinsharma121
authored
DOC: Enforce Numpy Docstring Validation for pandas.tseries.offsets.Week.name (#58633)
* DOC: add SA01 for tseries name methods * DOC: add SA01 for tseries name methods * DOC: remove SA01 for tseries name methods
1 parent 99e6938 commit 638254f

File tree

2 files changed

+8
-35
lines changed

2 files changed

+8
-35
lines changed

‎ci/code_checks.sh

-35
Original file line numberDiff line numberDiff line change
@@ -582,7 +582,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
582582
-i "pandas.tseries.offsets.BQuarterBegin.is_on_offset GL08" \
583583
-i "pandas.tseries.offsets.BQuarterBegin.kwds SA01" \
584584
-i "pandas.tseries.offsets.BQuarterBegin.n GL08" \
585-
-i "pandas.tseries.offsets.BQuarterBegin.name SA01" \
586585
-i "pandas.tseries.offsets.BQuarterBegin.nanos GL08" \
587586
-i "pandas.tseries.offsets.BQuarterBegin.normalize GL08" \
588587
-i "pandas.tseries.offsets.BQuarterBegin.rule_code GL08" \
@@ -592,7 +591,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
592591
-i "pandas.tseries.offsets.BQuarterEnd.is_on_offset GL08" \
593592
-i "pandas.tseries.offsets.BQuarterEnd.kwds SA01" \
594593
-i "pandas.tseries.offsets.BQuarterEnd.n GL08" \
595-
-i "pandas.tseries.offsets.BQuarterEnd.name SA01" \
596594
-i "pandas.tseries.offsets.BQuarterEnd.nanos GL08" \
597595
-i "pandas.tseries.offsets.BQuarterEnd.normalize GL08" \
598596
-i "pandas.tseries.offsets.BQuarterEnd.rule_code GL08" \
@@ -603,7 +601,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
603601
-i "pandas.tseries.offsets.BYearBegin.kwds SA01" \
604602
-i "pandas.tseries.offsets.BYearBegin.month GL08" \
605603
-i "pandas.tseries.offsets.BYearBegin.n GL08" \
606-
-i "pandas.tseries.offsets.BYearBegin.name SA01" \
607604
-i "pandas.tseries.offsets.BYearBegin.nanos GL08" \
608605
-i "pandas.tseries.offsets.BYearBegin.normalize GL08" \
609606
-i "pandas.tseries.offsets.BYearBegin.rule_code GL08" \
@@ -613,7 +610,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
613610
-i "pandas.tseries.offsets.BYearEnd.kwds SA01" \
614611
-i "pandas.tseries.offsets.BYearEnd.month GL08" \
615612
-i "pandas.tseries.offsets.BYearEnd.n GL08" \
616-
-i "pandas.tseries.offsets.BYearEnd.name SA01" \
617613
-i "pandas.tseries.offsets.BYearEnd.nanos GL08" \
618614
-i "pandas.tseries.offsets.BYearEnd.normalize GL08" \
619615
-i "pandas.tseries.offsets.BYearEnd.rule_code GL08" \
@@ -624,7 +620,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
624620
-i "pandas.tseries.offsets.BusinessDay.is_on_offset GL08" \
625621
-i "pandas.tseries.offsets.BusinessDay.kwds SA01" \
626622
-i "pandas.tseries.offsets.BusinessDay.n GL08" \
627-
-i "pandas.tseries.offsets.BusinessDay.name SA01" \
628623
-i "pandas.tseries.offsets.BusinessDay.nanos GL08" \
629624
-i "pandas.tseries.offsets.BusinessDay.normalize GL08" \
630625
-i "pandas.tseries.offsets.BusinessDay.rule_code GL08" \
@@ -637,7 +632,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
637632
-i "pandas.tseries.offsets.BusinessHour.is_on_offset GL08" \
638633
-i "pandas.tseries.offsets.BusinessHour.kwds SA01" \
639634
-i "pandas.tseries.offsets.BusinessHour.n GL08" \
640-
-i "pandas.tseries.offsets.BusinessHour.name SA01" \
641635
-i "pandas.tseries.offsets.BusinessHour.nanos GL08" \
642636
-i "pandas.tseries.offsets.BusinessHour.normalize GL08" \
643637
-i "pandas.tseries.offsets.BusinessHour.rule_code GL08" \
@@ -648,7 +642,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
648642
-i "pandas.tseries.offsets.BusinessMonthBegin.is_on_offset GL08" \
649643
-i "pandas.tseries.offsets.BusinessMonthBegin.kwds SA01" \
650644
-i "pandas.tseries.offsets.BusinessMonthBegin.n GL08" \
651-
-i "pandas.tseries.offsets.BusinessMonthBegin.name SA01" \
652645
-i "pandas.tseries.offsets.BusinessMonthBegin.nanos GL08" \
653646
-i "pandas.tseries.offsets.BusinessMonthBegin.normalize GL08" \
654647
-i "pandas.tseries.offsets.BusinessMonthBegin.rule_code GL08" \
@@ -657,7 +650,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
657650
-i "pandas.tseries.offsets.BusinessMonthEnd.is_on_offset GL08" \
658651
-i "pandas.tseries.offsets.BusinessMonthEnd.kwds SA01" \
659652
-i "pandas.tseries.offsets.BusinessMonthEnd.n GL08" \
660-
-i "pandas.tseries.offsets.BusinessMonthEnd.name SA01" \
661653
-i "pandas.tseries.offsets.BusinessMonthEnd.nanos GL08" \
662654
-i "pandas.tseries.offsets.BusinessMonthEnd.normalize GL08" \
663655
-i "pandas.tseries.offsets.BusinessMonthEnd.rule_code GL08" \
@@ -671,7 +663,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
671663
-i "pandas.tseries.offsets.CustomBusinessDay.is_on_offset GL08" \
672664
-i "pandas.tseries.offsets.CustomBusinessDay.kwds SA01" \
673665
-i "pandas.tseries.offsets.CustomBusinessDay.n GL08" \
674-
-i "pandas.tseries.offsets.CustomBusinessDay.name SA01" \
675666
-i "pandas.tseries.offsets.CustomBusinessDay.nanos GL08" \
676667
-i "pandas.tseries.offsets.CustomBusinessDay.normalize GL08" \
677668
-i "pandas.tseries.offsets.CustomBusinessDay.rule_code GL08" \
@@ -684,7 +675,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
684675
-i "pandas.tseries.offsets.CustomBusinessHour.is_on_offset GL08" \
685676
-i "pandas.tseries.offsets.CustomBusinessHour.kwds SA01" \
686677
-i "pandas.tseries.offsets.CustomBusinessHour.n GL08" \
687-
-i "pandas.tseries.offsets.CustomBusinessHour.name SA01" \
688678
-i "pandas.tseries.offsets.CustomBusinessHour.nanos GL08" \
689679
-i "pandas.tseries.offsets.CustomBusinessHour.normalize GL08" \
690680
-i "pandas.tseries.offsets.CustomBusinessHour.rule_code GL08" \
@@ -698,7 +688,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
698688
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.kwds SA01" \
699689
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.m_offset GL08" \
700690
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.n GL08" \
701-
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.name SA01" \
702691
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.nanos GL08" \
703692
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.normalize GL08" \
704693
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.rule_code GL08" \
@@ -711,7 +700,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
711700
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.kwds SA01" \
712701
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.m_offset GL08" \
713702
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.n GL08" \
714-
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.name SA01" \
715703
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.nanos GL08" \
716704
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.normalize GL08" \
717705
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.rule_code GL08" \
@@ -721,7 +709,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
721709
-i "pandas.tseries.offsets.DateOffset.is_on_offset GL08" \
722710
-i "pandas.tseries.offsets.DateOffset.kwds SA01" \
723711
-i "pandas.tseries.offsets.DateOffset.n GL08" \
724-
-i "pandas.tseries.offsets.DateOffset.name SA01" \
725712
-i "pandas.tseries.offsets.DateOffset.nanos GL08" \
726713
-i "pandas.tseries.offsets.DateOffset.normalize GL08" \
727714
-i "pandas.tseries.offsets.DateOffset.rule_code GL08" \
@@ -730,7 +717,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
730717
-i "pandas.tseries.offsets.Day.is_on_offset GL08" \
731718
-i "pandas.tseries.offsets.Day.kwds SA01" \
732719
-i "pandas.tseries.offsets.Day.n GL08" \
733-
-i "pandas.tseries.offsets.Day.name SA01" \
734720
-i "pandas.tseries.offsets.Day.nanos SA01" \
735721
-i "pandas.tseries.offsets.Day.normalize GL08" \
736722
-i "pandas.tseries.offsets.Day.rule_code GL08" \
@@ -739,7 +725,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
739725
-i "pandas.tseries.offsets.Easter.is_on_offset GL08" \
740726
-i "pandas.tseries.offsets.Easter.kwds SA01" \
741727
-i "pandas.tseries.offsets.Easter.n GL08" \
742-
-i "pandas.tseries.offsets.Easter.name SA01" \
743728
-i "pandas.tseries.offsets.Easter.nanos GL08" \
744729
-i "pandas.tseries.offsets.Easter.normalize GL08" \
745730
-i "pandas.tseries.offsets.Easter.rule_code GL08" \
@@ -750,7 +735,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
750735
-i "pandas.tseries.offsets.FY5253.is_on_offset GL08" \
751736
-i "pandas.tseries.offsets.FY5253.kwds SA01" \
752737
-i "pandas.tseries.offsets.FY5253.n GL08" \
753-
-i "pandas.tseries.offsets.FY5253.name SA01" \
754738
-i "pandas.tseries.offsets.FY5253.nanos GL08" \
755739
-i "pandas.tseries.offsets.FY5253.normalize GL08" \
756740
-i "pandas.tseries.offsets.FY5253.rule_code GL08" \
@@ -764,7 +748,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
764748
-i "pandas.tseries.offsets.FY5253Quarter.is_on_offset GL08" \
765749
-i "pandas.tseries.offsets.FY5253Quarter.kwds SA01" \
766750
-i "pandas.tseries.offsets.FY5253Quarter.n GL08" \
767-
-i "pandas.tseries.offsets.FY5253Quarter.name SA01" \
768751
-i "pandas.tseries.offsets.FY5253Quarter.nanos GL08" \
769752
-i "pandas.tseries.offsets.FY5253Quarter.normalize GL08" \
770753
-i "pandas.tseries.offsets.FY5253Quarter.qtr_with_extra_week GL08" \
@@ -778,7 +761,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
778761
-i "pandas.tseries.offsets.Hour.is_on_offset GL08" \
779762
-i "pandas.tseries.offsets.Hour.kwds SA01" \
780763
-i "pandas.tseries.offsets.Hour.n GL08" \
781-
-i "pandas.tseries.offsets.Hour.name SA01" \
782764
-i "pandas.tseries.offsets.Hour.nanos SA01" \
783765
-i "pandas.tseries.offsets.Hour.normalize GL08" \
784766
-i "pandas.tseries.offsets.Hour.rule_code GL08" \
@@ -787,7 +769,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
787769
-i "pandas.tseries.offsets.LastWeekOfMonth.is_on_offset GL08" \
788770
-i "pandas.tseries.offsets.LastWeekOfMonth.kwds SA01" \
789771
-i "pandas.tseries.offsets.LastWeekOfMonth.n GL08" \
790-
-i "pandas.tseries.offsets.LastWeekOfMonth.name SA01" \
791772
-i "pandas.tseries.offsets.LastWeekOfMonth.nanos GL08" \
792773
-i "pandas.tseries.offsets.LastWeekOfMonth.normalize GL08" \
793774
-i "pandas.tseries.offsets.LastWeekOfMonth.rule_code GL08" \
@@ -798,7 +779,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
798779
-i "pandas.tseries.offsets.Micro.is_on_offset GL08" \
799780
-i "pandas.tseries.offsets.Micro.kwds SA01" \
800781
-i "pandas.tseries.offsets.Micro.n GL08" \
801-
-i "pandas.tseries.offsets.Micro.name SA01" \
802782
-i "pandas.tseries.offsets.Micro.nanos SA01" \
803783
-i "pandas.tseries.offsets.Micro.normalize GL08" \
804784
-i "pandas.tseries.offsets.Micro.rule_code GL08" \
@@ -807,7 +787,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
807787
-i "pandas.tseries.offsets.Milli.is_on_offset GL08" \
808788
-i "pandas.tseries.offsets.Milli.kwds SA01" \
809789
-i "pandas.tseries.offsets.Milli.n GL08" \
810-
-i "pandas.tseries.offsets.Milli.name SA01" \
811790
-i "pandas.tseries.offsets.Milli.nanos SA01" \
812791
-i "pandas.tseries.offsets.Milli.normalize GL08" \
813792
-i "pandas.tseries.offsets.Milli.rule_code GL08" \
@@ -816,7 +795,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
816795
-i "pandas.tseries.offsets.Minute.is_on_offset GL08" \
817796
-i "pandas.tseries.offsets.Minute.kwds SA01" \
818797
-i "pandas.tseries.offsets.Minute.n GL08" \
819-
-i "pandas.tseries.offsets.Minute.name SA01" \
820798
-i "pandas.tseries.offsets.Minute.nanos SA01" \
821799
-i "pandas.tseries.offsets.Minute.normalize GL08" \
822800
-i "pandas.tseries.offsets.Minute.rule_code GL08" \
@@ -825,7 +803,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
825803
-i "pandas.tseries.offsets.MonthBegin.is_on_offset GL08" \
826804
-i "pandas.tseries.offsets.MonthBegin.kwds SA01" \
827805
-i "pandas.tseries.offsets.MonthBegin.n GL08" \
828-
-i "pandas.tseries.offsets.MonthBegin.name SA01" \
829806
-i "pandas.tseries.offsets.MonthBegin.nanos GL08" \
830807
-i "pandas.tseries.offsets.MonthBegin.normalize GL08" \
831808
-i "pandas.tseries.offsets.MonthBegin.rule_code GL08" \
@@ -834,7 +811,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
834811
-i "pandas.tseries.offsets.MonthEnd.is_on_offset GL08" \
835812
-i "pandas.tseries.offsets.MonthEnd.kwds SA01" \
836813
-i "pandas.tseries.offsets.MonthEnd.n GL08" \
837-
-i "pandas.tseries.offsets.MonthEnd.name SA01" \
838814
-i "pandas.tseries.offsets.MonthEnd.nanos GL08" \
839815
-i "pandas.tseries.offsets.MonthEnd.normalize GL08" \
840816
-i "pandas.tseries.offsets.MonthEnd.rule_code GL08" \
@@ -843,7 +819,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
843819
-i "pandas.tseries.offsets.Nano.is_on_offset GL08" \
844820
-i "pandas.tseries.offsets.Nano.kwds SA01" \
845821
-i "pandas.tseries.offsets.Nano.n GL08" \
846-
-i "pandas.tseries.offsets.Nano.name SA01" \
847822
-i "pandas.tseries.offsets.Nano.nanos SA01" \
848823
-i "pandas.tseries.offsets.Nano.normalize GL08" \
849824
-i "pandas.tseries.offsets.Nano.rule_code GL08" \
@@ -852,7 +827,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
852827
-i "pandas.tseries.offsets.QuarterBegin.is_on_offset GL08" \
853828
-i "pandas.tseries.offsets.QuarterBegin.kwds SA01" \
854829
-i "pandas.tseries.offsets.QuarterBegin.n GL08" \
855-
-i "pandas.tseries.offsets.QuarterBegin.name SA01" \
856830
-i "pandas.tseries.offsets.QuarterBegin.nanos GL08" \
857831
-i "pandas.tseries.offsets.QuarterBegin.normalize GL08" \
858832
-i "pandas.tseries.offsets.QuarterBegin.rule_code GL08" \
@@ -862,7 +836,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
862836
-i "pandas.tseries.offsets.QuarterEnd.is_on_offset GL08" \
863837
-i "pandas.tseries.offsets.QuarterEnd.kwds SA01" \
864838
-i "pandas.tseries.offsets.QuarterEnd.n GL08" \
865-
-i "pandas.tseries.offsets.QuarterEnd.name SA01" \
866839
-i "pandas.tseries.offsets.QuarterEnd.nanos GL08" \
867840
-i "pandas.tseries.offsets.QuarterEnd.normalize GL08" \
868841
-i "pandas.tseries.offsets.QuarterEnd.rule_code GL08" \
@@ -872,7 +845,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
872845
-i "pandas.tseries.offsets.Second.is_on_offset GL08" \
873846
-i "pandas.tseries.offsets.Second.kwds SA01" \
874847
-i "pandas.tseries.offsets.Second.n GL08" \
875-
-i "pandas.tseries.offsets.Second.name SA01" \
876848
-i "pandas.tseries.offsets.Second.nanos SA01" \
877849
-i "pandas.tseries.offsets.Second.normalize GL08" \
878850
-i "pandas.tseries.offsets.Second.rule_code GL08" \
@@ -882,7 +854,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
882854
-i "pandas.tseries.offsets.SemiMonthBegin.is_on_offset GL08" \
883855
-i "pandas.tseries.offsets.SemiMonthBegin.kwds SA01" \
884856
-i "pandas.tseries.offsets.SemiMonthBegin.n GL08" \
885-
-i "pandas.tseries.offsets.SemiMonthBegin.name SA01" \
886857
-i "pandas.tseries.offsets.SemiMonthBegin.nanos GL08" \
887858
-i "pandas.tseries.offsets.SemiMonthBegin.normalize GL08" \
888859
-i "pandas.tseries.offsets.SemiMonthBegin.rule_code GL08" \
@@ -892,7 +863,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
892863
-i "pandas.tseries.offsets.SemiMonthEnd.is_on_offset GL08" \
893864
-i "pandas.tseries.offsets.SemiMonthEnd.kwds SA01" \
894865
-i "pandas.tseries.offsets.SemiMonthEnd.n GL08" \
895-
-i "pandas.tseries.offsets.SemiMonthEnd.name SA01" \
896866
-i "pandas.tseries.offsets.SemiMonthEnd.nanos GL08" \
897867
-i "pandas.tseries.offsets.SemiMonthEnd.normalize GL08" \
898868
-i "pandas.tseries.offsets.SemiMonthEnd.rule_code GL08" \
@@ -901,7 +871,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
901871
-i "pandas.tseries.offsets.Tick.is_on_offset GL08" \
902872
-i "pandas.tseries.offsets.Tick.kwds SA01" \
903873
-i "pandas.tseries.offsets.Tick.n GL08" \
904-
-i "pandas.tseries.offsets.Tick.name SA01" \
905874
-i "pandas.tseries.offsets.Tick.nanos SA01" \
906875
-i "pandas.tseries.offsets.Tick.normalize GL08" \
907876
-i "pandas.tseries.offsets.Tick.rule_code GL08" \
@@ -910,7 +879,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
910879
-i "pandas.tseries.offsets.Week.is_on_offset GL08" \
911880
-i "pandas.tseries.offsets.Week.kwds SA01" \
912881
-i "pandas.tseries.offsets.Week.n GL08" \
913-
-i "pandas.tseries.offsets.Week.name SA01" \
914882
-i "pandas.tseries.offsets.Week.nanos GL08" \
915883
-i "pandas.tseries.offsets.Week.normalize GL08" \
916884
-i "pandas.tseries.offsets.Week.rule_code GL08" \
@@ -920,7 +888,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
920888
-i "pandas.tseries.offsets.WeekOfMonth.is_on_offset GL08" \
921889
-i "pandas.tseries.offsets.WeekOfMonth.kwds SA01" \
922890
-i "pandas.tseries.offsets.WeekOfMonth.n GL08" \
923-
-i "pandas.tseries.offsets.WeekOfMonth.name SA01" \
924891
-i "pandas.tseries.offsets.WeekOfMonth.nanos GL08" \
925892
-i "pandas.tseries.offsets.WeekOfMonth.normalize GL08" \
926893
-i "pandas.tseries.offsets.WeekOfMonth.rule_code GL08" \
@@ -932,7 +899,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
932899
-i "pandas.tseries.offsets.YearBegin.kwds SA01" \
933900
-i "pandas.tseries.offsets.YearBegin.month GL08" \
934901
-i "pandas.tseries.offsets.YearBegin.n GL08" \
935-
-i "pandas.tseries.offsets.YearBegin.name SA01" \
936902
-i "pandas.tseries.offsets.YearBegin.nanos GL08" \
937903
-i "pandas.tseries.offsets.YearBegin.normalize GL08" \
938904
-i "pandas.tseries.offsets.YearBegin.rule_code GL08" \
@@ -942,7 +908,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
942908
-i "pandas.tseries.offsets.YearEnd.kwds SA01" \
943909
-i "pandas.tseries.offsets.YearEnd.month GL08" \
944910
-i "pandas.tseries.offsets.YearEnd.n GL08" \
945-
-i "pandas.tseries.offsets.YearEnd.name SA01" \
946911
-i "pandas.tseries.offsets.YearEnd.nanos GL08" \
947912
-i "pandas.tseries.offsets.YearEnd.normalize GL08" \
948913
-i "pandas.tseries.offsets.YearEnd.rule_code GL08" \

‎pandas/_libs/tslibs/offsets.pyx

+8
Original file line numberDiff line numberDiff line change
@@ -558,6 +558,14 @@ cdef class BaseOffset:
558558
"""
559559
Return a string representing the base frequency.
560560

561+
See Also
562+
--------
563+
tseries.offsets.Week : Represents a weekly offset.
564+
DateOffset : Base class for all other offset classes.
565+
tseries.offsets.Day : Represents a single day offset.
566+
tseries.offsets.MonthEnd : Represents a monthly offset that
567+
snaps to the end of the month.
568+
561569
Examples
562570
--------
563571
>>> pd.offsets.Hour().name

0 commit comments

Comments
 (0)