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

removed colors argument for Table#scatter #389

Merged
merged 3 commits into from Sep 10, 2020

Conversation

adnanhemani
Copy link
Member

[N/A] Wrote test for feature
[X] Added changes in the Changelog section in README.md
[X] Bumped version number (delete if unneeded)

Changes proposed:
The next commit to remove support for the colors argument altogether and warn the user to use group instead.

# TODO: In a future release, warn that this is deprecated.
# Deprecated
# warnings.warn("scatter(colors=x) is deprecated. Use scatter(group=x)", FutureWarning)
if "colors" in vargs and vargs["colors"]:
Copy link
Member Author

Choose a reason for hiding this comment

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

Now that I think about it, this should warn on run of the code instead of just the first run. Thoughts?

Copy link
Member

Choose a reason for hiding this comment

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

Agreed. Seems like warning every time might be preferable.

@coveralls
Copy link

Coverage Status

Coverage increased (+0.05%) to 75.724% when pulling da10834 on consistent_args_legends into 2ba25c5 on master.

@deculler
Copy link
Contributor

deculler commented Jun 28, 2019 via email

@davidwagner
Copy link
Member

@adnanhemani, Right now we accept either group= or colors= (as of the latest version).
Next I'd like to deploy that, update all the course materials, and let that bake for a few days.
Then, I'd like to update so we accept either group= or colors=, but warn on use of colors=, and deploy that for a little while.
Then, after that's been out for a little while, we can remove support for colors= and only support group=.
I'd prefer to go through the intermediate step first before we merge this one.
So let's keep this one on hold until we've done those steps. Thanks for preparing this, it will be useful to us in the future!

@davidwagner
Copy link
Member

@deculler, we do have many instances of Table.scatter(..., colors=...) in the Data 8 course materials: see #384 (comment).

Your idea about supporting choosing a different color for each point with a colors column is a neat one. That sounds like something we can handle as a separate feature request. Want to file an issue for that feature request so we can keep track of it? We'll probably prioritize based on whether we have anyone who wants to use it.

@deculler
Copy link
Contributor

deculler commented Jun 28, 2019 via email

@adnanhemani
Copy link
Member Author

@davidwagner maybe we should look into merging this through at some point? I think all the class materials were changed a while back to reflect the new method signature?

@davidwagner davidwagner merged commit e028ca8 into master Sep 10, 2020
@davidwagner davidwagner deleted the consistent_args_legends branch September 10, 2020 06:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants