search

vega / altair

Declarative statistical visualization library for Python
https://altair-viz.github.io/
BSD 3-Clause "New" or "Revised" License
9.26k stars 791 forks source link

Update docs for vega_datasets v2 #2213

Open eitanlees opened 4 years ago

eitanlees commented 4 years ago

The vega/vega-datasets repository recently released a major update. We are working on updating altair-viz/vega_datasets to reflect v2. As a result many examples throughout the docs will need to be updated.

After https://github.com/altair-viz/vega_datasets/issues/39 is closed we can begin the process of cleaning up the docs.

For now I just wanted to make note of the transition.

jakevdp commented 4 years ago

Related: #2210, #2212

jakevdp commented 4 years ago

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.

eitanlees commented 4 years ago

I have compiled a big list of everything that needs to be changed once https://github.com/altair-viz/vega_datasets/pull/40 is merged.

From the Example Gallery

Broken

From the docs

Broken

joelostblom commented 3 years ago

@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 https://github.com/altair-viz/vega_datasets/pull/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.

joelostblom commented 3 years ago

Response to my question above here https://github.com/altair-viz/altair/pull/2310#issuecomment-705241724

cdeil commented 3 years ago

@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.

Screenshot 2020-11-24 at 22 02 35

jakevdp commented 3 years ago

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 release simultaneous with an altair release.