Skip to content
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

Add warning about derived docstrings early in the docstring #4716

Merged
merged 4 commits into from Apr 26, 2019

Conversation

@mrocklin
Copy link
Member

@mrocklin mrocklin commented Apr 18, 2019

Previously this was at the end of the docstring,
which many users fail to read.

  • Tests added / passed
  • Passes flake8 dask
Previously this was at the end of the docstring,
which many users fail to read.
@mrocklin
Copy link
Member Author

@mrocklin mrocklin commented Apr 18, 2019

If I get more time on this I may try to add disclaimers directly in the Parameters section as well.

@mrocklin
Copy link
Member Author

@mrocklin mrocklin commented Apr 22, 2019

cc @jcrist for review

dask/utils.py Outdated Show resolved Hide resolved
dask/utils.py Outdated Show resolved Hide resolved
@mrocklin
Copy link
Member Author

@mrocklin mrocklin commented Apr 24, 2019

Signature: dd.Series.dropna(self)
Docstring:
Return a new Series with missing values removed.

This docstring was copied from pandas.core.series.Series.dropna
Some inconsistencies with the Dask version may exist.

See the :ref:`User Guide <missing_data>` for more on which values are
considered missing, and how to work with missing data.

Parameters
----------
axis : {0 or 'index'}, default 0  (Not supported in Dask)
    There is only one axis to drop values from.
inplace : bool, default False  (Not supported in Dask)
    If True, do operation inplace and return None.
**kwargs
    Not in use.

Returns
-------
Series
    Series with NA entries dropped from it.

@mrocklin
Copy link
Member Author

@mrocklin mrocklin commented Apr 26, 2019

Merging in this afternoon if there are no further comments

@jcrist jcrist merged commit 5dff98f into dask:master Apr 26, 2019
2 checks passed
@jcrist jcrist deleted the derived_from branch Apr 26, 2019
@jcrist
Copy link
Member

@jcrist jcrist commented Apr 26, 2019

Thanks @mrocklin.

jorge-pessoa pushed a commit to jorge-pessoa/dask that referenced this issue May 14, 2019
* Add warning about derived docstrings early in the docstring

Previously this was at the end of the docstring,
which many users fail to read.

* flake and py27

* Intent properly, mark bad arguments

* support older version of pandas in test
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants