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 deprecation warnings for API changes #1005

Merged
merged 8 commits into from Jun 27, 2022

Conversation

jasongrout
Copy link
Member

This is a followup of #979, correcting our LegendControl docs where needed.

I left in a backwards-compatible shim for giving the name argument to the LegendControl, since that is likely the most common thing people would have to change.

…here needed.

I left in a backwards-compatible shim for giving the name argument to the LegendControl.
@jasongrout jasongrout marked this pull request as ready for review June 23, 2022 17:33
@jasongrout
Copy link
Member Author

In starting to do the release, and looking over the changelog one last time, I felt there needed to be more explanation and consistency in our docs around #979.

@jasongrout
Copy link
Member Author

Also I realized #982 wasn't documented in the changelog, so I did that too.

@jasongrout
Copy link
Member Author

I created an 0.17.0 milestone to have the issues I think should be in the release. If those two issues pass review and are merged, I am happy to do the 0.17.0 release:

https://github.com/jupyter-widgets/ipyleaflet/milestone/1

@jasongrout
Copy link
Member Author

@HaudinFlorence, you could also review this. Thanks again for the changes cleaning the api up!

@jasongrout
Copy link
Member Author

This also adds a top-level Releases category for the docs to give visibility to the changelog (and list of breaking changes, etc.)

This also adds back in some API changes as deprecated, and switches a few more from PendingDeprecationWarnings to DeprecationWarnings.
@jasongrout jasongrout changed the title Correct our LegendControl docs where needed Add deprecation warnings for API changes Jun 25, 2022
CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Member

@martinRenou martinRenou left a comment

Choose a reason for hiding this comment

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

Thanks!

ipyleaflet/leaflet.py Show resolved Hide resolved
@martinRenou martinRenou merged commit 855a8dd into jupyter-widgets:master Jun 27, 2022
HaudinFlorence pushed a commit to HaudinFlorence/ipyleaflet that referenced this pull request Jun 30, 2022
Add deprecation warnings for API changes
HaudinFlorence pushed a commit to HaudinFlorence/ipyleaflet that referenced this pull request Jun 30, 2022
Add deprecation warnings for API changes
HaudinFlorence pushed a commit to HaudinFlorence/ipyleaflet that referenced this pull request Jun 30, 2022
Add deprecation warnings for API changes
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

2 participants