DOC: update the pandas.Index.is_categorical docstring #20167

mariadelmarbibiloni · 2018-03-10T14:55:50Z

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

PR title is "DOC: update the docstring"
The validation script passes: scripts/validate_docstrings.py <your-function-or-method>
The PEP8 style check passes: git diff upstream/master -u -- "*.py" | flake8 --diff
The html version looks good: python doc/make.py --single <your-function-or-method>
It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

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

Errors found:
        See Also section not found

If the validation script still gives errors, but you think there is a good reason
to deviate in this case (and there are certainly such cases), please state this
explicitly.

We think that See Also is not necessary for this function.

TomAugspurger · 2018-03-10T14:59:45Z

What's the output of of the vlaidate_docstrings script?

TomAugspurger · 2018-03-10T15:00:17Z

pandas/core/indexes/base.py

+        """
+        Check if the index type is categorical.
+
+        The given object must be a pandas dataframe or pandas Series.


dataframe -> DataFrame

TomAugspurger · 2018-03-10T15:00:37Z

pandas/core/indexes/base.py

+        The given object must be a pandas dataframe or pandas Series.
+
+        Returns
+        ----------


This should be the same length as "Returns"

TomAugspurger

Minor things if you could update. looks good otherwise!

TomAugspurger · 2018-03-10T15:00:46Z

pandas/core/indexes/base.py

+
+        Examples
+        --------
+        >>> s = pd.Series(["Watermelon","Orange","Apple",


space after the commas

TomAugspurger · 2018-03-10T15:01:04Z

pandas/core/indexes/base.py

+        --------
+        >>> s = pd.Series(["Watermelon","Orange","Apple",
+        ...                 "Watermelon"]).astype('category')
+        >>> df = pd.DataFrame({'Weight (grams)':[2000,230,160,1300]}, index=s)


spcae after the colon. Space after commas.

Thank you for your comments ^^ !! We have already changed it.

TomAugspurger · 2018-03-10T15:01:41Z

pandas/core/indexes/base.py

+        >>> df.index.is_categorical()
+        True
+
+        >>> df = pd.Series(["Peter","Adam","Elisabeth","Margareth"])


call the ser = since it's a series :)

jbigatti · 2018-03-10T15:00:22Z

pandas/core/indexes/base.py

+
+        Examples
+        --------
+        >>> s = pd.Series(["Watermelon","Orange","Apple",


Space after ","

jbigatti · 2018-03-10T15:02:01Z

pandas/core/indexes/base.py

+        --------
+        >>> s = pd.Series(["Watermelon","Orange","Apple",
+        ...                 "Watermelon"]).astype('category')
+        >>> df = pd.DataFrame({'Weight (grams)':[2000,230,160,1300]}, index=s)


Space after ","

Thanks, we appreciate your comments! We have already changed it :)

…olved

jreback · 2018-03-10T17:23:34Z

pandas/core/indexes/base.py

+        """
+        Check if the Index type is categorical.
+
+        The given object must be a pandas DataFrame or pandas Series.


this only applies to a Series or an Index, IOW it must be 1D

Thanks @jreback ! I have changed the exended summary. Is it better now?

jreback · 2018-03-10T17:24:09Z

pandas/core/indexes/base.py

+        --------
+        >>> s = pd.Series(["Watermelon", "Orange", "Apple",
+        ...                 "Watermelon"]).astype('category')
+        >>> df = pd.DataFrame({'Weight (grams)': [2000, 230, 160, 1300]},


don't create a DataFrame here just to use its index, just use the series above

Ok, Thank you! I have changed the examples.

…ed summary

codecov · 2018-03-11T18:40:02Z

Codecov Report

❗ No coverage uploaded for pull request base (master@ac3d893). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master   #20167   +/-   ##
=========================================
  Coverage          ?    91.7%           
=========================================
  Files             ?      150           
  Lines             ?    49152           
  Branches          ?        0           
=========================================
  Hits              ?    45074           
  Misses            ?     4078           
  Partials          ?        0

Flag	Coverage Δ
#multiple	`90.08% <ø> (?)`
#single	`41.84% <ø> (?)`

Impacted Files	Coverage Δ
pandas/core/indexes/base.py	`96.66% <ø> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ac3d893...1461f4a. Read the comment docs.

TomAugspurger · 2018-03-11T21:56:36Z

pandas/core/indexes/base.py

+        """
+        Check if the Index type is categorical.
+
+        The given object must be a pandas DataFrame index or a pandas Series


I think it's best to just remove this. There isn't really an object being passed, it's just an attribute on Index classes.

Removed Extended summary

TomAugspurger · 2018-03-11T21:59:45Z

Just pushed a commit removing the extended sumary. Added a See Also for CategoricalIndex.

mariadelmarbibiloni · 2018-03-12T14:25:13Z

pandas/core/indexes/base.py

+
+        See Also
+        --------
+        CategoricalIndex : Index for categorical data.



Thanks a lot for the See Also!

mariadelmarbibiloni · 2018-03-12T14:29:54Z

pandas/core/indexes/base.py

-
-        The given object must be a pandas DataFrame index or a pandas Series
-        index.
+        Check if the Index holds categorical data.



I agree! Thank you :)

…ni-docstring_Index.is_categorical

TomAugspurger · 2018-03-12T14:32:12Z

Thank you for working on this.

pandas.Index.is_categorical from base.py documented

354795e

TomAugspurger added Docs Categorical Categorical Data Type labels Mar 10, 2018

TomAugspurger added this to the 0.23.0 milestone Mar 10, 2018

TomAugspurger reviewed Mar 10, 2018

View reviewed changes

jbigatti suggested changes Mar 10, 2018

View reviewed changes

pandas.Index.is_categorical from base.py documented and some errors s…

1755bee

…olved

jreback requested changes Mar 10, 2018

View reviewed changes

pandas.Index.is_categorical from base.py with new examples and extend…

5a972b4

…ed summary

TomAugspurger reviewed Mar 11, 2018

View reviewed changes

Added See Also.

e6e12c6

Removed Extended summary

Added back whitepace

a4586f2

mariadelmarbibiloni commented Mar 12, 2018

View reviewed changes

TomAugspurger added 2 commits March 12, 2018 09:30

to_frame formatting

218737a

Merge remote-tracking branch 'upstream/master' into mariadelmarbibilo…

1461f4a

…ni-docstring_Index.is_categorical

TomAugspurger merged commit 5888e36 into pandas-dev:master Mar 12, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: update the pandas.Index.is_categorical docstring #20167

DOC: update the pandas.Index.is_categorical docstring #20167

mariadelmarbibiloni commented Mar 10, 2018 •

edited

Loading

TomAugspurger commented Mar 10, 2018

TomAugspurger Mar 10, 2018

TomAugspurger Mar 10, 2018

TomAugspurger left a comment

TomAugspurger Mar 10, 2018

TomAugspurger Mar 10, 2018

mariadelmarbibiloni Mar 10, 2018

TomAugspurger Mar 10, 2018

jbigatti Mar 10, 2018

jbigatti Mar 10, 2018

mariadelmarbibiloni Mar 10, 2018

jreback Mar 10, 2018

mariadelmarbibiloni Mar 11, 2018

jreback Mar 10, 2018

mariadelmarbibiloni Mar 11, 2018

codecov bot commented Mar 11, 2018 •

edited

Loading

TomAugspurger Mar 11, 2018

TomAugspurger commented Mar 11, 2018

mariadelmarbibiloni Mar 12, 2018

mariadelmarbibiloni Mar 12, 2018

TomAugspurger commented Mar 12, 2018

DOC: update the pandas.Index.is_categorical docstring #20167

DOC: update the pandas.Index.is_categorical docstring #20167

Conversation

mariadelmarbibiloni commented Mar 10, 2018 • edited Loading

TomAugspurger commented Mar 10, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomAugspurger left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Mar 11, 2018 • edited Loading

Codecov Report

Choose a reason for hiding this comment

TomAugspurger commented Mar 11, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomAugspurger commented Mar 12, 2018

mariadelmarbibiloni commented Mar 10, 2018 •

edited

Loading

codecov bot commented Mar 11, 2018 •

edited

Loading