Skip to content

Better Documentation / Annotation Demanded #3

Description

@Feliconut

I would really appreciate it if you'd like to spend a little amount of time adding docstrings for the methods including their input and output format, and explicitly define the data exchanging format between modules. Even better if you can draw an entity-relationship diagram. In this way, I can understand your code better and build upon it to make it production-ready.

Also, I'd like to rewrite your PureData module in Python so everything becomes neat and simple to implement. I can do this effectively only if explicit, detailed data exchange format is provided.

You are a genius! Even more genius if you'd like to add more documentation! May God bless you!

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions