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

Document discord.channelType #1510

Closed
Icebluewolf opened this issue Jul 17, 2022 · 4 comments
Closed

Document discord.channelType #1510

Icebluewolf opened this issue Jul 17, 2022 · 4 comments
Labels
feature request New feature request on hold
Milestone

Comments

@Icebluewolf
Copy link
Contributor

Summary

Document discord.channelType. Also make it so the argument accepts the actually channel type or string and not and int for the ID of the channel type

What is the feature request for?

The documentation

The Problem

So people stop asking is its possible and so it is more clear.

The Ideal Solution

Document it.

The Current Solution

No response

Additional Context

I would do this but I have no idea how the documentation files work

@Icebluewolf Icebluewolf added the feature request New feature request label Jul 17, 2022
@Lulalaby
Copy link
Member

Then do it wolfy ♥️

@jdelucca
Copy link
Contributor

https://discord.com/channels/881207955029110855/881735314987708456/1029044538523799633

When using slash command options, if the slash command is asking for a channel type, make sure that the types show up as both ints and names, so that you don't have to go into documentation while trying to do a slash command. (if this behavior still exists)

@jdelucca
Copy link
Contributor

Looking into it, when using the channel type as an option, first Option recognizes that the option of class Enum, then overrides the description with the inspect.getdoc() of the enum.
Because there was no docstring for the enum classes, you would get "No description provided" even when you gave the Option a description string.
image

@Dorukyum
Copy link
Member

Completed in #1699.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request New feature request on hold
Projects
None yet
Development

No branches or pull requests

4 participants