axopy icon indicating copy to clipboard operation
axopy copied to clipboard

Better examples

Open ixjlyons opened this issue 5 years ago • 0 comments

I have a couple ideas for better examples.

  • Make more examples -- obvious
  • Heavily comment examples: AxoPy isn't really designed in a way where complex examples will necessarily flow logically top to bottom, but this could be a nice way to explain some of the tips and tricks. It'd be cool to render them sort of like a jupyter notebook with prose and code blocks interwoven. zetcode (http://zetcode.com/gui/pyqt5/) is an example that I think is pretty effective. I'd rather not manually include blocks of the example code with line numbers.
  • Run the examples like tests. I've recently gotten involved in pyqtgraph and I didn't realize they run all the examples with pytest. It's a little complex to set up and there will probably need to be a few improvements to how AxoPy uses the Qt event loop, but it'd be fantastic to automatically run the examples to at least there aren't silly syntax errors and such.

ixjlyons avatar May 30 '19 16:05 ixjlyons