Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API Mapping Audit #143

Open
Daniel-Worrall opened this issue Mar 24, 2022 · 3 comments
Open

API Mapping Audit #143

Daniel-Worrall opened this issue Mar 24, 2022 · 3 comments
Labels
enhancement New feature or request help wanted Extra attention is needed
Milestone

Comments

@Daniel-Worrall
Copy link
Member

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.

@Daniel-Worrall Daniel-Worrall added enhancement New feature or request help wanted Extra attention is needed labels Mar 24, 2022
@Daniel-Worrall Daniel-Worrall added this to the v4.0.0 milestone Mar 24, 2022
@swarley
Copy link
Member

swarley commented Mar 25, 2022

It would additionally be helpful to document any endpoints we currently cover and are now out of scope. An example would be some user only endpoints that may be hidden or deprecated functionality like bot group DM endpoints

@Daniel-Worrall
Copy link
Member Author

Thought we had a tracking issue on that, seems not. Ty for the addition
Related Issues #7 #98 #16 #86

@PanisSupraOmnia
Copy link
Member

It would additionally be helpful to document any endpoints we currently cover and are now out of scope.

I think I covered this in #98, but things may have changed, or I could have missed some things, and it would be good for my work to be double-checked anyway.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants