Skip to content

Need better documentation #72

@leofang

Description

@leofang

This includes at least

  1. docstrings for GUI functions
    • thoughts: most GUI methods are considered "private" in the sense that we are free to make changes to them as long as the effects are obvious to users. Users click buttons, not call the methods, after all.
  2. document or note for how new functions are added
    • pyqt style file and auto-gen script
    • main GUI class
    • interface class
    • backend
  3. cleanup to reduce future maintenance burden

This needs to be resolved soon so that when I am unavailable or stepping down from the maintainer role, @mrakitin or @LonglonWu can take over.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions