Discord.py: Documentation: BanEntry is not documented

Created on 3 Mar 2020  路  3Comments  路  Source: Rapptz/discord.py

In readthedocs Guild.fetch_ban() and Guild.bans() both mention a BanEntry. However, there is no further information in the documentation about this class since it does not link anywhere.

picture BIRD-UP73

Most helpful comment

This coroutine returns a list of BanEntry objects, which is a namedtuple with a user field to denote the User that got banned along with a reason field specifying why the user was banned that could be set to None.

  • from the docs
picture IAmTomahawkx on 3 Mar 2020
👍4

All 3 comments

This coroutine returns a list of BanEntry objects, which is a namedtuple with a user field to denote the User that got banned along with a reason field specifying why the user was banned that could be set to None.

  • from the docs
IAmTomahawkx picture IAmTomahawkx on 3 Mar 2020
👍4

The (not too uncommon) misunderstanding here is that a banentry, being a namedtuple is part of this library- it's actually part of collections.

It seems wise to me to link to that documentation from within the dpy documentation.

Vexs picture Vexs on 3 Mar 2020

This coroutine returns a list of BanEntry objects, which is a namedtuple with a user field to denote the User that got banned along with a reason field specifying why the user was banned that could be set to None.

  • from the docs

Why put this twice in the two functions though? Wouldn't it be easier to maintain to just make one explanation for BanEntry?

BIRD-UP73 picture BIRD-UP73 on 3 Mar 2020
👍1
Was this page helpful?
0 / 5 - 0 ratings

Related issues

MrBrahm picture MrBrahm  路  3Comments
JackL0 picture JackL0  路  3Comments
synbitz picture synbitz  路  3Comments
danshat picture danshat  路  3Comments
jzburda picture jzburda  路  3Comments