docstring

pandas-dev · jbrockmendel · Oct 15, 2018 · Oct 7, 2018 · Oct 9, 2018 · Oct 9, 2018
commit eb252bff0e8f12a228477d7cae507c538cd0abc5
diff --git a/pandas/core/arrays/period.py b/pandas/core/arrays/period.py
@@ -481,6 +481,25 @@ def _maybe_convert_timedelta(self, other):
                                                freqstr=self.freqstr))
 
     def _check_timedeltalike_freq_compat(self, other):
+        """
+        Arithmetic operations with timedelta-like scalars or array `other`
+        are only valid if `other` is an integer multiple of `self.freq`.
+        If the operation is valid, find that integer multiple.  Otherwise,
+        raise because the operation is invalid.
+
+        Parameters
+        ----------
+        other : timedelta, np.timedelta64, Tick,
+                ndarray[timedelta64], TimedeltaArray, TimedeltaIndex
+
+        Returns
+        -------
+        multiple : int or ndarray[int64]
+
+        Raises
+        ------
+        IncompatibleFrequency
+        """
         assert isinstance(self.freq, Tick)  # checked by calling function
         own_offset = frequencies.to_offset(self.freq.rule_code)
         base_nanos = delta_to_nanoseconds(own_offset)