Skip to content

Changed kind parameter from integer to int, Added example #32361

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
Feb 29, 2020

Conversation

zakybilfagih
Copy link
Contributor

@zakybilfagih zakybilfagih commented Feb 29, 2020

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

3 Errors found:
        Parameter "sparse_index" has no description
        Parameter "index" has no description
        See Also section not found

@@ -231,7 +231,7 @@ class SparseArray(PandasObject, ExtensionArray, ExtensionOpsMixin):
3. ``data.dtype.fill_value`` if `fill_value` is None and `dtype`
is not a ``SparseDtype`` and `data` is a ``SparseArray``.

kind : {'integer', 'block'}, default 'integer'
kind : {'int', 'block'}, default 'int'
Copy link
Member

Choose a reason for hiding this comment

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

Please revert this line

Copy link
Contributor Author

@zakybilfagih zakybilfagih Feb 29, 2020

Choose a reason for hiding this comment

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

Hey, thanks for the reply :)
After reverting the line, an error pops up on the validate_doctring.py test, is that ok?
@MomIsBestFriend

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

4 Errors found:
        Parameter "sparse_index" has no description
        Parameter "index" has no description
        **Parameter "kind" type should use "int" instead of "integer"**
        See Also section not found

Copy link
Member

Choose a reason for hiding this comment

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

This is a known bug with the validator (see #25205) so just have to ignore for now

Copy link
Member

@ShaharNaveh ShaharNaveh left a comment

Choose a reason for hiding this comment

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

LGTM

@WillAyd WillAyd added this to the 1.1 milestone Feb 29, 2020
@WillAyd WillAyd merged commit 712000e into pandas-dev:master Feb 29, 2020
@WillAyd
Copy link
Member

WillAyd commented Feb 29, 2020

Great thanks @mackarelfish !

roberthdevries pushed a commit to roberthdevries/pandas that referenced this pull request Mar 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants