Skip to content

Start Documenting the code #12

Open
@surajkumar

Description

@surajkumar

Context

We need some documentation so end users know what some of the fields on our models are.
The documentation should inform of the following:

  • What a field/method means
  • What constraints are present
  • Behavior of a field, when is a value present?
  • How do we get the value if it's not present?
  • Can this be influenced by external factors?

Try link back to the API documentation as much as possible.

https://discord.com/developers/docs/intro

Acceptance Criteria

There is documentation on the models package.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    Status

    Ready

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions