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

DOC: Add Index.difference to API doc #10185

Merged
merged 1 commit into from
May 23, 2015

Conversation

sinhrks
Copy link
Member

@sinhrks sinhrks commented May 21, 2015

Add Index.difference to api doc rather than deprecated Index.diff (#8226)

And is it OK to remove Index.diff alias because #6581 lists #8227 (which closes #8226)?

@sinhrks sinhrks added the Docs label May 21, 2015
@sinhrks sinhrks added this to the 0.17.0 milestone May 21, 2015
@@ -1262,7 +1262,7 @@ Modifying and Computations
Index.argmax
Index.copy
Index.delete
Index.diff
Index.difference
Copy link
Member

Choose a reason for hiding this comment

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

But I think this does not belong in this section at all, as this is not a 'computation' function

I would rather put it together with the other set operation methods

@jreback
Copy link
Contributor

jreback commented May 21, 2015

yep no problem with changing this in the API docs (but move as @jorisvandenbossche mentions)

@jorisvandenbossche
Copy link
Member

The deprecation of Index.diff is actually not explicitely mentioned in #6581, we should add that. Also, we should clean up that list for 0.17, as not all things listed there should already be removed in 0.17

@jreback
Copy link
Contributor

jreback commented May 21, 2015

@jorisvandenbossche yep, that list really should be for 'next-major-release' then separate section for 0.17.0

@sinhrks
Copy link
Member Author

sinhrks commented May 22, 2015

I think it is natural under the same category as intersection and union. How about moving difference and sym_diff to "Combining / joining / merging" category, renaming it to "Combining / joining / set operations"?

@jorisvandenbossche
Copy link
Member

yes, sounds good to me

@jreback
Copy link
Contributor

jreback commented May 22, 2015

agreed, making a new sub-section for setops would be gr8.

@sinhrks
Copy link
Member Author

sinhrks commented May 23, 2015

OK, did the suggested change. Pls check.

jorisvandenbossche added a commit that referenced this pull request May 23, 2015
DOC: Add Index.difference to API doc
@jorisvandenbossche jorisvandenbossche merged commit 9b04bd0 into pandas-dev:master May 23, 2015
@sinhrks sinhrks deleted the diff_doc branch May 23, 2015 14:29
@jorisvandenbossche jorisvandenbossche modified the milestones: 0.17.0, 0.16.2 Jun 2, 2015
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.

API: make '+' and '-' for Index either do numeric operations of raise TypeError (instead of setops)
3 participants