Skip to content

DOC add extended summary, update parameter types desc, update return types desc, and add whitespaces after commas in list declarations to DataFrame.first in core/generic.py #32018

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 10, 2020
Merged

DOC add extended summary, update parameter types desc, update return types desc, and add whitespaces after commas in list declarations to DataFrame.first in core/generic.py #32018

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9e6907f
DOC add summaries and descriptions to DataFrame.first in core/generic
Feb 15, 2020
58fe573
truncate module name from parameters in DataFrame.first
Feb 15, 2020
01f2e7a
Merge remote-tracking branch 'upstream/master' into 20200215-sagungrp…
datapythonista Mar 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8014,15 +8014,21 @@ def resample(

def first(self: FrameOrSeries, offset) -> FrameOrSeries:
"""
Method to subset initial periods of time series data based on a date offset.
Select initial periods of time series data based on a date offset.

When having a DataFrame with dates as index, this function can
select the first few rows based on a date offset.

Parameters
----------
offset : str, DateOffset, dateutil.relativedelta
offset : str, DateOffset or dateutil.relativedelta
The offset length of the data that will be selected. For instance,
'1M' will display all the rows having their index within the first month.

Returns
-------
subset : same type as caller
Series or DataFrame
A subset of the caller.

Raises
------
Expand All @@ -8038,7 +8044,7 @@ def first(self: FrameOrSeries, offset) -> FrameOrSeries:
Examples
--------
>>> i = pd.date_range('2018-04-09', periods=4, freq='2D')
>>> ts = pd.DataFrame({'A': [1,2,3,4]}, index=i)
>>> ts = pd.DataFrame({'A': [1, 2, 3, 4]}, index=i)
>>> ts
A
2018-04-09 1
Expand Down