siphon icon indicating copy to clipboard operation
siphon copied to clipboard

Improving Example Docs

Open ahuang11 opened this issue 7 years ago • 1 comments

When I was scrolling through the examples, particularly the first example, I was a bit confused on how I could really apply the example because it just returns a list (wasn't sure what I could do with the list).

image

Thanks to John, I found their workshop tutorial which contained an extended version of the example and I found it to be much more useful.

https://github.com/Unidata/unidata-python-workshop/blob/master/notebooks/Siphon/Siphon%20Tutorial.ipynb

tldr: https://github.com/Unidata/unidata-python-workshop/blob/master/notebooks/Siphon/Siphon%20Tutorial.ipynb and https://unidata.github.io/python-gallery/index.html should be linked somewhere because it has many applicable examples that the current example's page does not!

ahuang11 avatar May 03 '18 01:05 ahuang11

Linking to the workshop in general is a good idea. What would make the most sense though is to steal the ideas from the workshop notebook and incorporate them directly into a few examples.

dopplershift avatar May 03 '18 03:05 dopplershift