Skip to content

Method descriptions missing from Sounds Modules #44

Description

@Zorba256

I'm starting to get interested in exploring audio in Python and was excited to discover the capabilities of your Jupylet project.

But I've just realized that although the documentation is extensive, many of the classes in the Sound and related modules only have the attributes defined, not the methods. Is this an oversight, or because they are waiting updating for the latest code changes or just because you have not got around to documenting them yet?

I note that the code itself is quite well documented, so perhaps there is an issue with documentation not getting automatically generated from the docstrings correctly?

I know that I can find out basic information about the classes using the Python "help" function but this does give any explanation of the methods, just the bare bones of class definitions.

Anyway, you're the expert and I'm only guessing but if you would like help in this area, then I've got the time (if only limited expertise) so I could have a go at helping with documentation.

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