Migration guide for custom widget libraries #1594
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This guide is very much based on the migration for jupyter-gmaps. It'll be useful to migrate other widget libraries and see what's fallen through the cracks.
jasongrout
reviewed
Aug 8, 2017
docs/source/migration_guides.md
Outdated
|
|
||
| Next, we should update the JavaScript dependencies. The most important change | ||
| for widget developers is that the JavaScript package for jupyter-widgets has | ||
| been split between `@jupyter-widgets/base` and `@jupyter-widgets/control`: |
jasongrout
reviewed
Aug 8, 2017
| `@jupyter-widgets/controls` if you think you have a dependency on it (e.g. if | ||
| you create widgets that inherit from `VBox` or `HBox` or another user-facing widget). | ||
|
|
||
| ### Updating Webpack configuration |
There was a problem hiding this comment.
One other thing is that the requirejs configuration in the classic notebook extension should no longer have a jupyter-js-widgets entry - see the change at bqplot/bqplot@7afcb19#diff-c0ff43d45628755eae045a0eec2fc1bdL21
There was a problem hiding this comment.
I've added a note for removing the entry in the requirejs config.
I have also added a reference to the PRs in bqplot that are relevant to the migration.
|
This looks great. Several comments inline, and I think it can be merged. Thanks! |
Some of the spaces in the headings were fancy unicode characters instead of actual spaces. This lead to issues with parsing markdown.
|
Looks good! I tweaked the wording just a bit in the changelog. Thanks again! |
github-actions
bot
added
the
resolved-locked
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Several developers of custom widget libraries have expressed concerns about the migration to jupyter-widgets 7. This aims to provide a step-by-step guide to the migration for custom widget developers.
At the moment, this is strongly based on the migration for
jupyter-gmaps, but I want to try and migrate other libraries to validate it (and figure out what's missing).I included this as a new top-level entry in the user guide, but this could also go somewhere else if more appropriate.