Skip to content

Commit 4d20f92

Browse files
GuessWhoSamFooalanbato
authored andcommitted
DOC: Add Timestamp, Period, Timedelta, and Interval to api.rst (pandas-dev#17424)
1 parent 9aaa8c9 commit 4d20f92

File tree

2 files changed

+196
-1
lines changed

2 files changed

+196
-1
lines changed

doc/source/api.rst

+195
Original file line numberDiff line numberDiff line change
@@ -1599,6 +1599,201 @@ Conversion
15991599
TimedeltaIndex.floor
16001600
TimedeltaIndex.ceil
16011601

1602+
.. currentmodule:: pandas
1603+
1604+
Scalars
1605+
-------
1606+
1607+
Period
1608+
~~~~~~
1609+
.. autosummary::
1610+
:toctree: generated/
1611+
1612+
Period
1613+
1614+
Attributes
1615+
~~~~~~~~~~
1616+
.. autosummary::
1617+
:toctree: generated/
1618+
1619+
Period.day
1620+
Period.dayofweek
1621+
Period.dayofyear
1622+
Period.days_in_month
1623+
Period.daysinmonth
1624+
Period.end_time
1625+
Period.freq
1626+
Period.freqstr
1627+
Period.hour
1628+
Period.is_leap_year
1629+
Period.minute
1630+
Period.month
1631+
Period.now
1632+
Period.ordinal
1633+
Period.quarter
1634+
Period.qyear
1635+
Period.second
1636+
Period.start_time
1637+
Period.strftime
1638+
Period.week
1639+
Period.weekday
1640+
Period.weekofyear
1641+
Period.year
1642+
1643+
Methods
1644+
~~~~~~~
1645+
.. autosummary::
1646+
:toctree: generated/
1647+
1648+
Period.asfreq
1649+
Period.strftime
1650+
Period.to_timestamp
1651+
1652+
Timestamp
1653+
~~~~~~~~~
1654+
.. autosummary::
1655+
:toctree: generated/
1656+
1657+
Timestamp
1658+
1659+
Properties
1660+
~~~~~~~~~~
1661+
.. autosummary::
1662+
:toctree: generated/
1663+
1664+
Timestamp.asm8
1665+
Timestamp.day
1666+
Timestamp.dayofweek
1667+
Timestamp.dayofyear
1668+
Timestamp.days_in_month
1669+
Timestamp.daysinmonth
1670+
Timestamp.hour
1671+
Timestamp.is_leap_year
1672+
Timestamp.is_month_end
1673+
Timestamp.is_month_start
1674+
Timestamp.is_quarter_end
1675+
Timestamp.is_quarter_start
1676+
Timestamp.is_year_end
1677+
Timestamp.is_year_start
1678+
Timestamp.max
1679+
Timestamp.microsecond
1680+
Timestamp.min
1681+
Timestamp.month
1682+
Timestamp.nanosecond
1683+
Timestamp.quarter
1684+
Timestamp.resolution
1685+
Timestamp.second
1686+
Timestamp.tz
1687+
Timestamp.tzinfo
1688+
Timestamp.value
1689+
Timestamp.weekday_name
1690+
Timestamp.weekofyear
1691+
Timestamp.year
1692+
1693+
Methods
1694+
~~~~~~~
1695+
.. autosummary::
1696+
:toctree: generated/
1697+
1698+
Timestamp.astimezone
1699+
Timestamp.ceil
1700+
Timestamp.combine
1701+
Timestamp.ctime
1702+
Timestamp.date
1703+
Timestamp.dst
1704+
Timestamp.floor
1705+
Timestamp.freq
1706+
Timestamp.freqstr
1707+
Timestamp.from_ordinal
1708+
Timestamp.fromtimestamp
1709+
Timestamp.isocalendar
1710+
Timestamp.isoformat
1711+
Timestamp.isoweekday
1712+
Timestamp.normalize
1713+
Timestamp.now
1714+
Timestamp.replace
1715+
Timestamp.round
1716+
Timestamp.strftime
1717+
Timestamp.strptime
1718+
Timestamp.time
1719+
Timestamp.timetuple
1720+
Timestamp.timetz
1721+
Timestamp.to_datetime64
1722+
Timestamp.to_julian_date
1723+
Timestamp.to_period
1724+
Timestamp.to_pydatetime
1725+
Timestamp.today
1726+
Timestamp.toordinal
1727+
Timestamp.tz_convert
1728+
Timestamp.tz_localize
1729+
Timestamp.tzname
1730+
Timestamp.utcfromtimestamp
1731+
Timestamp.utcnow
1732+
Timestamp.utcoffset
1733+
Timestamp.utctimetuple
1734+
Timestamp.weekday
1735+
1736+
Interval
1737+
~~~~~~~~
1738+
.. autosummary::
1739+
:toctree: generated/
1740+
1741+
Interval
1742+
1743+
Properties
1744+
~~~~~~~~~~
1745+
.. autosummary::
1746+
:toctree generated/
1747+
1748+
Interval.closed
1749+
Interval.closed_left
1750+
Interval.closed_right
1751+
Interval.left
1752+
Interval.mid
1753+
Interval.open_left
1754+
Interval.open_right
1755+
Interval.right
1756+
1757+
Timedelta
1758+
~~~~~~~~~
1759+
.. autosummary::
1760+
:toctree: generated/
1761+
1762+
Timedelta
1763+
1764+
Properties
1765+
~~~~~~~~~~
1766+
.. autosummary::
1767+
:toctree generated/
1768+
1769+
Timedelta.asm8
1770+
Timedelta.components
1771+
Timedelta.days
1772+
Timedelta.delta
1773+
Timedelta.freq
1774+
Timedelta.is_populated
1775+
Timedelta.max
1776+
Timedelta.microseconds
1777+
Timedelta.min
1778+
Timedelta.nanoseconds
1779+
Timedelta.resolution
1780+
Timedelta.seconds
1781+
Timedelta.value
1782+
1783+
Methods
1784+
~~~~~~~
1785+
.. autosummary::
1786+
:toctree generated/
1787+
1788+
Timedelta.ceil
1789+
Timedelta.floor
1790+
Timedelta.isoformat
1791+
Timedelta.round
1792+
Timdelta.to_pytimedelta
1793+
Timedelta.to_timedelta64
1794+
Timedelta.total_seconds
1795+
Timedelta.view
1796+
16021797
Window
16031798
------
16041799
.. currentmodule:: pandas.core.window

pandas/_libs/period.pyx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1102,7 +1102,7 @@ cdef class _Period(object):
11021102

11031103
class Period(_Period):
11041104
"""
1105-
Represents an period of time
1105+
Represents a period of time
11061106
11071107
Parameters
11081108
----------

0 commit comments

Comments
 (0)