enthought / mayavi

3D visualization of scientific data in Python
http://docs.enthought.com/mayavi/mayavi/
Other
1.3k stars 284 forks source link

Broken examples #1116

Open ManPython opened 2 years ago

ManPython commented 2 years ago

https://docs.enthought.com/mayavi/mayavi/auto/example_offscreen.html#example-offscreen https://docs.enthought.com/mayavi/mayavi/auto/example_glyph.html#example-glyph https://docs.enthought.com/mayavi/mayavi/auto/example_contour_contour.html#example-contour-contour https://docs.enthought.com/mayavi/mayavi/auto/example_scatter_plot.html#example-scatter-plot https://docs.enthought.com/mayavi/mayavi/auto/example_zzz_reader.html#example-zzz-reader https://docs.enthought.com/mayavi/mayavi/auto/example_structured_points2d.html#example-structured-points2d

And other.. This need verifications

BTW.. need some simple example of 2d line chart, candlestick, histogram.

Becheler commented 2 years ago

Manually copy/pasting example code is a bit of a pain. One way to make sure example code always work would be to:

  1. Write an integration test with the example code to be displayed
  2. Make sure the tests pass
  3. Use github actions to automatically fetch the validated source code, e.g. using Markdown autodoc: https://github.com/marketplace/actions/markdown-autodocs It's a bit costly to get it working, but when it's down, it's really convenient and ensures that all code snippets are always valid :)
ManPython commented 2 years ago

I think that is good case for create some Test Drive module in future. Right?