Skip to content

Updated series documentation to close #35406 #36139

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.

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 2 commits into from
Sep 5, 2020

Conversation

TAJD
Copy link
Contributor

@TAJD TAJD commented Sep 5, 2020

Not sure how to do whatsnew entry for this - first contribution! Do let me know how to improve.

Output of scripts/validate_docstring.py:

################################################################################
########################## Docstring (pandas.Series)  ##########################
################################################################################

One-dimensional ndarray with axis labels (including time series).

Labels need not be unique but must be a hashable type. The object
supports both integer- and label-based indexing and provides a host of
methods for performing operations involving the index. Statistical
methods from ndarray have been overridden to automatically exclude
missing data (currently represented as NaN).

Operations between Series (+, -, /, *, **) align values based on their
associated index values-- they need not be the same length. The result
index will be the sorted union of the two indexes.

Parameters
----------
data : array-like, Iterable, dict, or scalar value
    Contains data stored in Series.

    .. versionchanged:: 0.23.0
       If data is a dict, argument order is maintained for Python 3.6
       and later.

index : array-like or Index (1d)
    Values must be hashable and have the same length as `data`.
    Non-unique index values are allowed. Will default to
    RangeIndex (0, 1, 2, ..., n) if not provided. If data is dict-like
    and index is None, then the values in the index are used to
    reindex the Series after it is created using the keys in the data.
dtype : str, numpy.dtype, or ExtensionDtype, optional
    Data type for the output Series. If not specified, this will be
    inferred from `data`.
    See the :ref:`user guide <basics.dtypes>` for more usages.
name : str, optional
    The name to give to the Series.
copy : bool, default False
    Copy input data.

################################################################################
################################## Validation ##################################
################################################################################

3 Errors found:
        Parameters {'fastpath'} not documented
        See Also section not found
        No examples section found

Thomas Dickson added 2 commits September 5, 2020 14:11
Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @TAJD - no need for a whatsnew entry here

@jreback jreback added Docs Series Series data structure Constructors Series/DataFrame/Index/pd.array Constructors labels Sep 5, 2020
@jreback jreback added this to the 1.2 milestone Sep 5, 2020
@jreback
Copy link
Contributor

jreback commented Sep 5, 2020

cc @TomAugspurger

@TomAugspurger TomAugspurger merged commit c4f0c6f into pandas-dev:master Sep 5, 2020
@TomAugspurger
Copy link
Contributor

Thanks!

jbrockmendel pushed a commit to jbrockmendel/pandas that referenced this pull request Sep 8, 2020
@TAJD TAJD deleted the series-documentation branch September 13, 2020 15:28
kesmit13 pushed a commit to kesmit13/pandas that referenced this pull request Nov 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Constructors Series/DataFrame/Index/pd.array Constructors Docs Series Series data structure
Projects
None yet
Development

Successfully merging this pull request may close these issues.

BUG: Creating a Series from a Series results in all NaN values
4 participants