Skip to content

Provide more information in API docstrings #7

@flpa

Description

@flpa

In my opinion, documentation of API methods should be extended so that it's easier to use them without looking up their source or experimenting.

For example, get-subreddit-new is described with "Gets json data for /r/< sub>/new. Optional user."
I think it'd be helpful to mention that the function returns a list of link objects.

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