Skip to content

Better examples #66

@ixjlyons

Description

@ixjlyons

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation improvements, errors, etc.enhancementNew feature, improved performance, etc.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions