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

Use ESDoc tags to document API client #27

@OrdinaryJellyfish

Description

@OrdinaryJellyfish

The usage in the README is great for basic things, and for getting started, but there's a lot more in the API client that could be used. Currently (afaik) those methods are undocumented. However, I would suggest adding ESDoc tags to allow IDEs such as Visual Studio Code to offer documentation for required parameters and a quick description on each method when you're writing your code. ESDoc tags is a great way to improve understanding when you're writing code for me, and I think this library should totally use it (manually reading code to see what it does and how to use it is boring).

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