Skip to content

Commit fa59ac4

Browse files
DOC: Enforce Numpy Docstring Validation for pandas.tseries copy methods (#58610)
* DOC: add SA01 for tseries copy methods * DOC: remove SA01 for tseries copy methods
1 parent 9b76144 commit fa59ac4

File tree

2 files changed

+7
-35
lines changed

2 files changed

+7
-35
lines changed

ci/code_checks.sh

-35
Original file line numberDiff line numberDiff line change
@@ -586,7 +586,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
586586
-i "pandas.tseries.offsets.BMonthBegin PR02" \
587587
-i "pandas.tseries.offsets.BMonthEnd PR02" \
588588
-i "pandas.tseries.offsets.BQuarterBegin PR02" \
589-
-i "pandas.tseries.offsets.BQuarterBegin.copy SA01" \
590589
-i "pandas.tseries.offsets.BQuarterBegin.freqstr SA01" \
591590
-i "pandas.tseries.offsets.BQuarterBegin.is_on_offset GL08" \
592591
-i "pandas.tseries.offsets.BQuarterBegin.kwds SA01" \
@@ -597,7 +596,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
597596
-i "pandas.tseries.offsets.BQuarterBegin.rule_code GL08" \
598597
-i "pandas.tseries.offsets.BQuarterBegin.startingMonth GL08" \
599598
-i "pandas.tseries.offsets.BQuarterEnd PR02" \
600-
-i "pandas.tseries.offsets.BQuarterEnd.copy SA01" \
601599
-i "pandas.tseries.offsets.BQuarterEnd.freqstr SA01" \
602600
-i "pandas.tseries.offsets.BQuarterEnd.is_on_offset GL08" \
603601
-i "pandas.tseries.offsets.BQuarterEnd.kwds SA01" \
@@ -608,7 +606,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
608606
-i "pandas.tseries.offsets.BQuarterEnd.rule_code GL08" \
609607
-i "pandas.tseries.offsets.BQuarterEnd.startingMonth GL08" \
610608
-i "pandas.tseries.offsets.BYearBegin PR02" \
611-
-i "pandas.tseries.offsets.BYearBegin.copy SA01" \
612609
-i "pandas.tseries.offsets.BYearBegin.freqstr SA01" \
613610
-i "pandas.tseries.offsets.BYearBegin.is_on_offset GL08" \
614611
-i "pandas.tseries.offsets.BYearBegin.kwds SA01" \
@@ -619,7 +616,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
619616
-i "pandas.tseries.offsets.BYearBegin.normalize GL08" \
620617
-i "pandas.tseries.offsets.BYearBegin.rule_code GL08" \
621618
-i "pandas.tseries.offsets.BYearEnd PR02" \
622-
-i "pandas.tseries.offsets.BYearEnd.copy SA01" \
623619
-i "pandas.tseries.offsets.BYearEnd.freqstr SA01" \
624620
-i "pandas.tseries.offsets.BYearEnd.is_on_offset GL08" \
625621
-i "pandas.tseries.offsets.BYearEnd.kwds SA01" \
@@ -631,7 +627,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
631627
-i "pandas.tseries.offsets.BYearEnd.rule_code GL08" \
632628
-i "pandas.tseries.offsets.BusinessDay PR02,SA01" \
633629
-i "pandas.tseries.offsets.BusinessDay.calendar GL08" \
634-
-i "pandas.tseries.offsets.BusinessDay.copy SA01" \
635630
-i "pandas.tseries.offsets.BusinessDay.freqstr SA01" \
636631
-i "pandas.tseries.offsets.BusinessDay.holidays GL08" \
637632
-i "pandas.tseries.offsets.BusinessDay.is_on_offset GL08" \
@@ -644,7 +639,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
644639
-i "pandas.tseries.offsets.BusinessDay.weekmask GL08" \
645640
-i "pandas.tseries.offsets.BusinessHour PR02,SA01" \
646641
-i "pandas.tseries.offsets.BusinessHour.calendar GL08" \
647-
-i "pandas.tseries.offsets.BusinessHour.copy SA01" \
648642
-i "pandas.tseries.offsets.BusinessHour.end GL08" \
649643
-i "pandas.tseries.offsets.BusinessHour.freqstr SA01" \
650644
-i "pandas.tseries.offsets.BusinessHour.holidays GL08" \
@@ -658,7 +652,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
658652
-i "pandas.tseries.offsets.BusinessHour.start GL08" \
659653
-i "pandas.tseries.offsets.BusinessHour.weekmask GL08" \
660654
-i "pandas.tseries.offsets.BusinessMonthBegin PR02" \
661-
-i "pandas.tseries.offsets.BusinessMonthBegin.copy SA01" \
662655
-i "pandas.tseries.offsets.BusinessMonthBegin.freqstr SA01" \
663656
-i "pandas.tseries.offsets.BusinessMonthBegin.is_on_offset GL08" \
664657
-i "pandas.tseries.offsets.BusinessMonthBegin.kwds SA01" \
@@ -668,7 +661,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
668661
-i "pandas.tseries.offsets.BusinessMonthBegin.normalize GL08" \
669662
-i "pandas.tseries.offsets.BusinessMonthBegin.rule_code GL08" \
670663
-i "pandas.tseries.offsets.BusinessMonthEnd PR02" \
671-
-i "pandas.tseries.offsets.BusinessMonthEnd.copy SA01" \
672664
-i "pandas.tseries.offsets.BusinessMonthEnd.freqstr SA01" \
673665
-i "pandas.tseries.offsets.BusinessMonthEnd.is_on_offset GL08" \
674666
-i "pandas.tseries.offsets.BusinessMonthEnd.kwds SA01" \
@@ -682,7 +674,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
682674
-i "pandas.tseries.offsets.CDay PR02,SA01" \
683675
-i "pandas.tseries.offsets.CustomBusinessDay PR02,SA01" \
684676
-i "pandas.tseries.offsets.CustomBusinessDay.calendar GL08" \
685-
-i "pandas.tseries.offsets.CustomBusinessDay.copy SA01" \
686677
-i "pandas.tseries.offsets.CustomBusinessDay.freqstr SA01" \
687678
-i "pandas.tseries.offsets.CustomBusinessDay.holidays GL08" \
688679
-i "pandas.tseries.offsets.CustomBusinessDay.is_on_offset GL08" \
@@ -695,7 +686,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
695686
-i "pandas.tseries.offsets.CustomBusinessDay.weekmask GL08" \
696687
-i "pandas.tseries.offsets.CustomBusinessHour PR02,SA01" \
697688
-i "pandas.tseries.offsets.CustomBusinessHour.calendar GL08" \
698-
-i "pandas.tseries.offsets.CustomBusinessHour.copy SA01" \
699689
-i "pandas.tseries.offsets.CustomBusinessHour.end GL08" \
700690
-i "pandas.tseries.offsets.CustomBusinessHour.freqstr SA01" \
701691
-i "pandas.tseries.offsets.CustomBusinessHour.holidays GL08" \
@@ -710,7 +700,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
710700
-i "pandas.tseries.offsets.CustomBusinessHour.weekmask GL08" \
711701
-i "pandas.tseries.offsets.CustomBusinessMonthBegin PR02" \
712702
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.calendar GL08" \
713-
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.copy SA01" \
714703
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.freqstr SA01" \
715704
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.holidays GL08" \
716705
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.is_on_offset SA01" \
@@ -724,7 +713,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
724713
-i "pandas.tseries.offsets.CustomBusinessMonthBegin.weekmask GL08" \
725714
-i "pandas.tseries.offsets.CustomBusinessMonthEnd PR02" \
726715
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.calendar GL08" \
727-
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.copy SA01" \
728716
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.freqstr SA01" \
729717
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.holidays GL08" \
730718
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.is_on_offset SA01" \
@@ -737,7 +725,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
737725
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.rule_code GL08" \
738726
-i "pandas.tseries.offsets.CustomBusinessMonthEnd.weekmask GL08" \
739727
-i "pandas.tseries.offsets.DateOffset PR02" \
740-
-i "pandas.tseries.offsets.DateOffset.copy SA01" \
741728
-i "pandas.tseries.offsets.DateOffset.freqstr SA01" \
742729
-i "pandas.tseries.offsets.DateOffset.is_on_offset GL08" \
743730
-i "pandas.tseries.offsets.DateOffset.kwds SA01" \
@@ -747,7 +734,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
747734
-i "pandas.tseries.offsets.DateOffset.normalize GL08" \
748735
-i "pandas.tseries.offsets.DateOffset.rule_code GL08" \
749736
-i "pandas.tseries.offsets.Day PR02" \
750-
-i "pandas.tseries.offsets.Day.copy SA01" \
751737
-i "pandas.tseries.offsets.Day.freqstr SA01" \
752738
-i "pandas.tseries.offsets.Day.is_on_offset GL08" \
753739
-i "pandas.tseries.offsets.Day.kwds SA01" \
@@ -757,7 +743,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
757743
-i "pandas.tseries.offsets.Day.normalize GL08" \
758744
-i "pandas.tseries.offsets.Day.rule_code GL08" \
759745
-i "pandas.tseries.offsets.Easter PR02" \
760-
-i "pandas.tseries.offsets.Easter.copy SA01" \
761746
-i "pandas.tseries.offsets.Easter.freqstr SA01" \
762747
-i "pandas.tseries.offsets.Easter.is_on_offset GL08" \
763748
-i "pandas.tseries.offsets.Easter.kwds SA01" \
@@ -767,7 +752,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
767752
-i "pandas.tseries.offsets.Easter.normalize GL08" \
768753
-i "pandas.tseries.offsets.Easter.rule_code GL08" \
769754
-i "pandas.tseries.offsets.FY5253 PR02" \
770-
-i "pandas.tseries.offsets.FY5253.copy SA01" \
771755
-i "pandas.tseries.offsets.FY5253.freqstr SA01" \
772756
-i "pandas.tseries.offsets.FY5253.get_rule_code_suffix GL08" \
773757
-i "pandas.tseries.offsets.FY5253.get_year_end GL08" \
@@ -782,7 +766,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
782766
-i "pandas.tseries.offsets.FY5253.variation GL08" \
783767
-i "pandas.tseries.offsets.FY5253.weekday GL08" \
784768
-i "pandas.tseries.offsets.FY5253Quarter PR02" \
785-
-i "pandas.tseries.offsets.FY5253Quarter.copy SA01" \
786769
-i "pandas.tseries.offsets.FY5253Quarter.freqstr SA01" \
787770
-i "pandas.tseries.offsets.FY5253Quarter.get_rule_code_suffix GL08" \
788771
-i "pandas.tseries.offsets.FY5253Quarter.get_weeks GL08" \
@@ -799,7 +782,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
799782
-i "pandas.tseries.offsets.FY5253Quarter.weekday GL08" \
800783
-i "pandas.tseries.offsets.FY5253Quarter.year_has_extra_week GL08" \
801784
-i "pandas.tseries.offsets.Hour PR02" \
802-
-i "pandas.tseries.offsets.Hour.copy SA01" \
803785
-i "pandas.tseries.offsets.Hour.freqstr SA01" \
804786
-i "pandas.tseries.offsets.Hour.is_on_offset GL08" \
805787
-i "pandas.tseries.offsets.Hour.kwds SA01" \
@@ -809,7 +791,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
809791
-i "pandas.tseries.offsets.Hour.normalize GL08" \
810792
-i "pandas.tseries.offsets.Hour.rule_code GL08" \
811793
-i "pandas.tseries.offsets.LastWeekOfMonth PR02,SA01" \
812-
-i "pandas.tseries.offsets.LastWeekOfMonth.copy SA01" \
813794
-i "pandas.tseries.offsets.LastWeekOfMonth.freqstr SA01" \
814795
-i "pandas.tseries.offsets.LastWeekOfMonth.is_on_offset GL08" \
815796
-i "pandas.tseries.offsets.LastWeekOfMonth.kwds SA01" \
@@ -821,7 +802,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
821802
-i "pandas.tseries.offsets.LastWeekOfMonth.week GL08" \
822803
-i "pandas.tseries.offsets.LastWeekOfMonth.weekday GL08" \
823804
-i "pandas.tseries.offsets.Micro PR02" \
824-
-i "pandas.tseries.offsets.Micro.copy SA01" \
825805
-i "pandas.tseries.offsets.Micro.freqstr SA01" \
826806
-i "pandas.tseries.offsets.Micro.is_on_offset GL08" \
827807
-i "pandas.tseries.offsets.Micro.kwds SA01" \
@@ -831,7 +811,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
831811
-i "pandas.tseries.offsets.Micro.normalize GL08" \
832812
-i "pandas.tseries.offsets.Micro.rule_code GL08" \
833813
-i "pandas.tseries.offsets.Milli PR02" \
834-
-i "pandas.tseries.offsets.Milli.copy SA01" \
835814
-i "pandas.tseries.offsets.Milli.freqstr SA01" \
836815
-i "pandas.tseries.offsets.Milli.is_on_offset GL08" \
837816
-i "pandas.tseries.offsets.Milli.kwds SA01" \
@@ -841,7 +820,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
841820
-i "pandas.tseries.offsets.Milli.normalize GL08" \
842821
-i "pandas.tseries.offsets.Milli.rule_code GL08" \
843822
-i "pandas.tseries.offsets.Minute PR02" \
844-
-i "pandas.tseries.offsets.Minute.copy SA01" \
845823
-i "pandas.tseries.offsets.Minute.freqstr SA01" \
846824
-i "pandas.tseries.offsets.Minute.is_on_offset GL08" \
847825
-i "pandas.tseries.offsets.Minute.kwds SA01" \
@@ -851,7 +829,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
851829
-i "pandas.tseries.offsets.Minute.normalize GL08" \
852830
-i "pandas.tseries.offsets.Minute.rule_code GL08" \
853831
-i "pandas.tseries.offsets.MonthBegin PR02" \
854-
-i "pandas.tseries.offsets.MonthBegin.copy SA01" \
855832
-i "pandas.tseries.offsets.MonthBegin.freqstr SA01" \
856833
-i "pandas.tseries.offsets.MonthBegin.is_on_offset GL08" \
857834
-i "pandas.tseries.offsets.MonthBegin.kwds SA01" \
@@ -861,7 +838,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
861838
-i "pandas.tseries.offsets.MonthBegin.normalize GL08" \
862839
-i "pandas.tseries.offsets.MonthBegin.rule_code GL08" \
863840
-i "pandas.tseries.offsets.MonthEnd PR02" \
864-
-i "pandas.tseries.offsets.MonthEnd.copy SA01" \
865841
-i "pandas.tseries.offsets.MonthEnd.freqstr SA01" \
866842
-i "pandas.tseries.offsets.MonthEnd.is_on_offset GL08" \
867843
-i "pandas.tseries.offsets.MonthEnd.kwds SA01" \
@@ -871,7 +847,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
871847
-i "pandas.tseries.offsets.MonthEnd.normalize GL08" \
872848
-i "pandas.tseries.offsets.MonthEnd.rule_code GL08" \
873849
-i "pandas.tseries.offsets.Nano PR02" \
874-
-i "pandas.tseries.offsets.Nano.copy SA01" \
875850
-i "pandas.tseries.offsets.Nano.freqstr SA01" \
876851
-i "pandas.tseries.offsets.Nano.is_on_offset GL08" \
877852
-i "pandas.tseries.offsets.Nano.kwds SA01" \
@@ -881,7 +856,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
881856
-i "pandas.tseries.offsets.Nano.normalize GL08" \
882857
-i "pandas.tseries.offsets.Nano.rule_code GL08" \
883858
-i "pandas.tseries.offsets.QuarterBegin PR02" \
884-
-i "pandas.tseries.offsets.QuarterBegin.copy SA01" \
885859
-i "pandas.tseries.offsets.QuarterBegin.freqstr SA01" \
886860
-i "pandas.tseries.offsets.QuarterBegin.is_on_offset GL08" \
887861
-i "pandas.tseries.offsets.QuarterBegin.kwds SA01" \
@@ -892,7 +866,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
892866
-i "pandas.tseries.offsets.QuarterBegin.rule_code GL08" \
893867
-i "pandas.tseries.offsets.QuarterBegin.startingMonth GL08" \
894868
-i "pandas.tseries.offsets.QuarterEnd PR02" \
895-
-i "pandas.tseries.offsets.QuarterEnd.copy SA01" \
896869
-i "pandas.tseries.offsets.QuarterEnd.freqstr SA01" \
897870
-i "pandas.tseries.offsets.QuarterEnd.is_on_offset GL08" \
898871
-i "pandas.tseries.offsets.QuarterEnd.kwds SA01" \
@@ -903,7 +876,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
903876
-i "pandas.tseries.offsets.QuarterEnd.rule_code GL08" \
904877
-i "pandas.tseries.offsets.QuarterEnd.startingMonth GL08" \
905878
-i "pandas.tseries.offsets.Second PR02" \
906-
-i "pandas.tseries.offsets.Second.copy SA01" \
907879
-i "pandas.tseries.offsets.Second.freqstr SA01" \
908880
-i "pandas.tseries.offsets.Second.is_on_offset GL08" \
909881
-i "pandas.tseries.offsets.Second.kwds SA01" \
@@ -913,7 +885,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
913885
-i "pandas.tseries.offsets.Second.normalize GL08" \
914886
-i "pandas.tseries.offsets.Second.rule_code GL08" \
915887
-i "pandas.tseries.offsets.SemiMonthBegin PR02,SA01" \
916-
-i "pandas.tseries.offsets.SemiMonthBegin.copy SA01" \
917888
-i "pandas.tseries.offsets.SemiMonthBegin.day_of_month GL08" \
918889
-i "pandas.tseries.offsets.SemiMonthBegin.freqstr SA01" \
919890
-i "pandas.tseries.offsets.SemiMonthBegin.is_on_offset GL08" \
@@ -924,7 +895,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
924895
-i "pandas.tseries.offsets.SemiMonthBegin.normalize GL08" \
925896
-i "pandas.tseries.offsets.SemiMonthBegin.rule_code GL08" \
926897
-i "pandas.tseries.offsets.SemiMonthEnd PR02,SA01" \
927-
-i "pandas.tseries.offsets.SemiMonthEnd.copy SA01" \
928898
-i "pandas.tseries.offsets.SemiMonthEnd.day_of_month GL08" \
929899
-i "pandas.tseries.offsets.SemiMonthEnd.freqstr SA01" \
930900
-i "pandas.tseries.offsets.SemiMonthEnd.is_on_offset GL08" \
@@ -935,7 +905,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
935905
-i "pandas.tseries.offsets.SemiMonthEnd.normalize GL08" \
936906
-i "pandas.tseries.offsets.SemiMonthEnd.rule_code GL08" \
937907
-i "pandas.tseries.offsets.Tick GL08" \
938-
-i "pandas.tseries.offsets.Tick.copy SA01" \
939908
-i "pandas.tseries.offsets.Tick.freqstr SA01" \
940909
-i "pandas.tseries.offsets.Tick.is_on_offset GL08" \
941910
-i "pandas.tseries.offsets.Tick.kwds SA01" \
@@ -945,7 +914,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
945914
-i "pandas.tseries.offsets.Tick.normalize GL08" \
946915
-i "pandas.tseries.offsets.Tick.rule_code GL08" \
947916
-i "pandas.tseries.offsets.Week PR02" \
948-
-i "pandas.tseries.offsets.Week.copy SA01" \
949917
-i "pandas.tseries.offsets.Week.freqstr SA01" \
950918
-i "pandas.tseries.offsets.Week.is_on_offset GL08" \
951919
-i "pandas.tseries.offsets.Week.kwds SA01" \
@@ -956,7 +924,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
956924
-i "pandas.tseries.offsets.Week.rule_code GL08" \
957925
-i "pandas.tseries.offsets.Week.weekday GL08" \
958926
-i "pandas.tseries.offsets.WeekOfMonth PR02,SA01" \
959-
-i "pandas.tseries.offsets.WeekOfMonth.copy SA01" \
960927
-i "pandas.tseries.offsets.WeekOfMonth.freqstr SA01" \
961928
-i "pandas.tseries.offsets.WeekOfMonth.is_on_offset GL08" \
962929
-i "pandas.tseries.offsets.WeekOfMonth.kwds SA01" \
@@ -968,7 +935,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
968935
-i "pandas.tseries.offsets.WeekOfMonth.week GL08" \
969936
-i "pandas.tseries.offsets.WeekOfMonth.weekday GL08" \
970937
-i "pandas.tseries.offsets.YearBegin PR02" \
971-
-i "pandas.tseries.offsets.YearBegin.copy SA01" \
972938
-i "pandas.tseries.offsets.YearBegin.freqstr SA01" \
973939
-i "pandas.tseries.offsets.YearBegin.is_on_offset GL08" \
974940
-i "pandas.tseries.offsets.YearBegin.kwds SA01" \
@@ -979,7 +945,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
979945
-i "pandas.tseries.offsets.YearBegin.normalize GL08" \
980946
-i "pandas.tseries.offsets.YearBegin.rule_code GL08" \
981947
-i "pandas.tseries.offsets.YearEnd PR02" \
982-
-i "pandas.tseries.offsets.YearEnd.copy SA01" \
983948
-i "pandas.tseries.offsets.YearEnd.freqstr SA01" \
984949
-i "pandas.tseries.offsets.YearEnd.is_on_offset GL08" \
985950
-i "pandas.tseries.offsets.YearEnd.kwds SA01" \

pandas/_libs/tslibs/offsets.pyx

+7
Original file line numberDiff line numberDiff line change
@@ -500,6 +500,13 @@ cdef class BaseOffset:
500500
"""
501501
Return a copy of the frequency.
502502
503+
See Also
504+
--------
505+
tseries.offsets.Week.copy : Return a copy of Week offset.
506+
tseries.offsets.DateOffset.copy : Return a copy of date offset.
507+
tseries.offsets.MonthEnd.copy : Return a copy of MonthEnd offset.
508+
tseries.offsets.YearBegin.copy : Return a copy of YearBegin offset.
509+
503510
Examples
504511
--------
505512
>>> freq = pd.DateOffset(1)

0 commit comments

Comments
 (0)