DisnakeDev / disnake

An API wrapper for Discord written in Python.
https://docs.disnake.dev
MIT License
721 stars 137 forks source link

Missing class in documentation may lead to confusion #1198

Closed Skelmis closed 2 months ago

Skelmis commented 5 months ago

Summary

Class ThreadWithMessage is not publically documented which may lead to some confusion for users trying to debug error messages using the class

Reproduction Steps

ThreadWithMessage was exported in PR 879 however it does not appear to have been added to the documentation.

As seen here the class does find use, but given it's lack of public docs it requires source code diving to understand how to use it.

For example when the class is returned, the documentation simply show it as the following non-named tuple: image

This may lead to confusion as users could struggle to debug it themselves since it isn't in the docs for public API things

Minimal Reproducible Code

No response

Expected Results

This class is exported in the documentation

Actual Results

It is not

Intents

NA

System Information

NA

Checklist

Additional Context

No response