Skip to content
This repository was archived by the owner on Feb 8, 2025. It is now read-only.
This repository was archived by the owner on Feb 8, 2025. It is now read-only.

code lacks documentation #15

@seannybgoode

Description

@seannybgoode

This is a great package, but it's severely lacking in even the most basic level of documentation.

Yeah, the code is self-documenting for the standard use case, kind-of, but what about the non standard cases? What are the interval values? Can they be zero for single run background tasks? What's the timeout value? What should it be set to generally? Does it depend on the kind of task being run?

Don't make people dig through your code to understand how it works.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions