pycord icon indicating copy to clipboard operation
pycord copied to clipboard

Document `discord.channelType`

Open Icebluewolf opened this issue 2 years ago • 1 comments

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 avatar Jul 17 '22 19:07 Icebluewolf

Then do it wolfy ♥️

Lulalaby avatar Jul 17 '22 21:07 Lulalaby

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 avatar Oct 10 '22 15:10 jdelucca

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

jdelucca avatar Oct 12 '22 16:10 jdelucca

Completed in #1699.

Dorukyum avatar Nov 30 '23 07:11 Dorukyum