Skip to content
This repository was archived by the owner on Oct 25, 2024. It is now read-only.
This repository was archived by the owner on Oct 25, 2024. It is now read-only.

Class usage descriptions  #117

@PhazonicRidley

Description

@PhazonicRidley

It would be helpful for classes to have quick blurbs on the intended use case. Either by describing recommended use case (this is already done to some extent) of which interfaces do what (hal::write(), create(), etc). Or by having a quick code example. An example of what this could look like: https://discordpy.readthedocs.io/en/stable/api.html?highlight=wait_for#discord.Client.wait_for

Metadata

Metadata

Assignees

No one assigned

    Labels

    🧩 apiThis issue affects library APIs in some way

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions