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

Vague description for UserContextMenuCommandInteraction properties description in Docs #8713

Closed
vunsh opened this issue Oct 6, 2022 · 1 comment · Fixed by #8717
Closed

Comments

@vunsh
Copy link

vunsh commented Oct 6, 2022

Which package is the feature request for?

discord.js

Feature

Looking at the v14 documentation for UserContextMenuCommandInteraction, some of the properties have contradicting descriptions. With testing its clear what each property contains, but the documentation should be clear and concise on what the property actually is.

UserContextMenu#targetId currently has an ideal description

UserContextMenu#targetUser currently has a vague description that makes it sound like it contains the user object of the person who originated the interaction.

UserContextMenu#targetMember has this same format.

Ideal solution or implementation

The ideal solution would be to update the description for these properties

Ex.
UserContextMenu#targetUser
The user of the target for this interaction.

UserContextMenu#targetMember
The member of the target for this interaction.

Alternative solutions or implementations

No response

Other context

This has the same wording for the v13 equivalent of a UserContextMenu. If this gets considered, updating the v13 docs would be a good idea as well.

@Jiralite
Copy link
Member

Jiralite commented Oct 6, 2022

Looking at this too, I believe they should change. I'd rather treat this as a bug than a feature request. If you look at UserContextMenuCommandInteraction#user, it's actually the same wording as UserContextMenuCommandInteraction#targetUser!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants