bjlittle / geovista

Cartographic rendering and mesh analytics powered by PyVista
https://geovista.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
154 stars 23 forks source link

Examples improvement: highlight with/without `connectivity` in unstructured examples #824

Open trexfeathers opened 2 months ago

trexfeathers commented 2 months ago

📚 Documentation

Half the unstructured examples don't use the connectivity= parameter in Transform.from_unstructured(), while the other half do. Something different is clearly happening under the hood, but it is not obvious what (in fact I need to do some investigating before I understand it!). I think it would be good to highlight the difference within the relevant examples.

Happy to have a go at this if I can make the time.

bjlittle commented 2 months ago

My aim was to keep the gallery examples informative to showcase specific features, but simple i.e., not bloat the narrative with any deeper explanations.

Instead, there will be places in the geovista documentation where a fuller treatment and explanation of the how, what and why e.g., either through the tutorials, how-to guides or enrichment material.

Once the supporting documentation is available, then I think it would be ideal to link to the relevant material from the gallery examples.

Does that seem like a reasonable approach?