Skip to content

Commit 7149795

Browse files
committed
Fix docstring checks
Validate Docstrings Error: /home/runner/work/pandas/pandas/pandas/core/indexes/datetimes.py:296:SS06:pandas.DatetimeIndex.to_julian_date:Summary should fit in a single line Error: /home/runner/work/pandas/pandas/pandas/core/indexes/datetimes.py:296:SS03:pandas.DatetimeIndex.to_julian_date:Summary does not end with a period Error: /home/runner/work/pandas/pandas/pandas/core/indexes/datetimes.py:296:EX01:pandas.DatetimeIndex.to_julian_date:No examples section found Error: /home/runner/work/pandas/pandas/pandas/core/indexes/datetimes.py:296:RT01:pandas.DatetimeIndex.to_julian_date:No Returns section found Error: /home/runner/work/pandas/pandas/pandas/core/indexes/datetimes.py:296:SA01:pandas.DatetimeIndex.to_julian_date:See Also section not found Validate Docstrings DONE Error: Process completed with exit code 5.
1 parent 7261c62 commit 7149795

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

pandas/core/arrays/datetimes.py

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2254,9 +2254,26 @@ def isocalendar(self) -> DataFrame:
22542254

22552255
def to_julian_date(self) -> npt.NDArray[np.float64]:
22562256
"""
2257-
Convert Datetime Array to float64 ndarray of Julian Dates.
2258-
0 Julian date is noon January 1, 4713 BC.
2257+
Convert TimeStamp to a Julian Date.
2258+
2259+
This method returns the number of days as a float since
2260+
22592261
https://en.wikipedia.org/wiki/Julian_day
2262+
2263+
Returns
2264+
-------
2265+
ndarray or Index
2266+
Float values that represent each date in Julian Calendar.
2267+
2268+
See Also
2269+
--------
2270+
Timestamp.to_julian_date : this same method on ``Timestamp`` objects.
2271+
2272+
Examples
2273+
--------
2274+
>>> idx = pd.DatetimeIndex(["2028-08-12 00:54", "2028-08-12 02:06"])
2275+
>>> idx.to_julian_date()
2276+
Index([2461995.5375, 2461995.5875], dtype='float64')
22602277
"""
22612278

22622279
# http://mysite.verizon.net/aesir_research/date/jdalg2.htm

0 commit comments

Comments
 (0)