-
-
Notifications
You must be signed in to change notification settings - Fork 4k
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
docs: undocument private constructors #6732
docs: undocument private constructors #6732
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Was gonna submit the review about the external links as soon as Jiralite did it so LGTM xD
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually, most of these constructors are public in the typings, could you go through them and make them private?
Is there a way, short of |
There is one: |
Please describe the changes this PR makes and why it should be merged:
This PR removes documentation for private constructors.
Those being documented confused library consumers into thinking that they are supposed / intended to instantiate those classes themselves.
Some constructors were intended to be documented due to
Structures.extend
use-cases, but this feature has, since then, been removed.Changed classes:
Shard
ShardClientUtil
BaseGuildTextChannel
ClientPresence
DMChannel
GuildBan
GuildChannel
GuildEmoji
GuildTemplate
Message
MessageReaction
Presence
Role
Sticker
StickerPack
StoreChannel
ThreadChannel
ThreadMember
Typing
User
VoiceState
Widget
WidgetMember
This PR also modifies the types to no longer allow instantiation where unintended, this includes few more classes than listed above.
Status and versioning classification: