Skip to content

API Mapping Audit #143

@Daniel-Worrall

Description

@Daniel-Worrall

With 3.5 approaching and 4.0 being the target afterwards, one important task that the community can help with gets stronger in my mind.

We'd love to have 100% documentation to library mapping of objects, properties, and API calls.
Some things fall through the cracks and we can't have an eagle eye on every single documentation change (and the changelog isn't perfect).

What I'd like to propose is an audit of all the Objects/Properties/API calls that Discordrb exposes, and to find all the ones we're missing. There are some properties that are simply not useful to keep track of, but we can make that decision after the differences have been found. We'd then also have a reference of which ones we don't have and why.

I also have plans to track all documentation commits to assess whether anything needs to be changed and create tracking issues for them where relevant. This will come after the audit has happened to save on work.

If you'd like to work on this, please let it be known on the issue, so others don't duplicate your work. Please include which objects you're looking at, and update your post as you move onto others.

I will be starting on this task in the coming weeks, but feel free to get a headstart on this.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requesthelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions