-
Notifications
You must be signed in to change notification settings - Fork 794
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
Update docs for vega-datasets>=2.0.0
#2213
Comments
Note that some docs are currently broken due to the changes in vega/vega-datasets, due to using URL data that has changed or been removed in vega-datasets. |
I have compiled a big list of everything that needs to be changed once altair-viz/vega_datasets#40 is merged. Moved to issue description
From the Example GalleryBroken
Needs Update
From the docsBroken
Needs Update
|
@eitanlees @jakevdp Is there anything I can do to assist with this that is not already covered by #2231, #2241, and #2310 (I just opened this for the weather data)? It seems like altair-viz/vega_datasets#40 is ready also. I am teaching a course with Altair next week and want to make sure students have a good experience reading the documentation, so let me know if I can help out. |
Response to my question above here #2310 (comment) |
@jakevdp @ellisonbg - any chance to get the example dataset URL issues resolved for Altair? I noticed the broken example in the docs and found this issue. Looks like there's open PRs with fixes already. |
Current broken docs fixed by using vega_datasets 0.9, which loads datasets from CDN to get around the broken URLs introduced by vega/vega-datasets version 2.0. Going forward, we need to do some more work, mainly to remove the iris examples throughout the docs, so that the docs will be compatible with the datasets now available in vega-datasets 2.0. The renamed fields in vega-datasets 2.0 are going to be more difficult, because there's not really any way to make Altair's docs compatible with both the old and the new version at once. So we'll need a |
vega-datasets>=2.0.0
Removed the bug label as broken examples were resolved indirectly by altair-viz/vega_datasets#45 The related upstream PR that would have fixed this directly by updating to I've updated the description to more accurately reflect current plans |
Important
This issue originally targeted vega-datasets@v2.0.0 via altair-viz/vega_datasets.
Many of the changes are still relevant, but we will be targeting vega-datasets@v3.0.0 by using #3631
Major releases from vega/vega-datasets have the potential to break examples throughout the
altair
docs.As a result many examples will need to be updated
Tracking
3.0.0
Release vega-datasets#654altair.datasets
#3631Changes
From the Example Gallery
Broken
movies
movies
seattle_temps
movies
movies
movies
Needs Update
iris
iris
iris
From the docs
Broken
movies
movies
movies
seattle_temps
seattle_temps
movies
movies
iris
iris
iris
Needs Update
iris
iris
iris
iris
seattle_temps
seattle_temps
seattle_temps
The text was updated successfully, but these errors were encountered: