Add dunder method docstring

[clot27]

Closes #3926

[Bibo-Joshi]

Thanks for the nice PR! I left some comments below :)

One (unrelated) thing that I noticed is that Bot.__eq__ doesn't comply with the documentation of TelegramObject.__eq__, i.e. it doesn't fall back to super().__eq__. Since so for Bot.__eq__ is not explicitly documented, it might be wise to adjust this before adding documentation would make this a (very minor) breaking change. What do you think?
cc @Poolitzer @harshil21

[Bibo-Joshi]

Thanks for the updates! Just two smaller comments below :) What dou you think about #3929 (review) ?

[harshil21]

Since so for Bot.eq is not explicitly documented, it might be wise to adjust this before adding documentation would make this a (very minor) breaking change. What do you think?

I agree, should be updated, though we will need to add an _id_attrs for Bot as well, what should that include?

Also telegram.ext.updater.rst still has the :special-members: in it, should be deleted.

Also I believe that a side effect of adding the special-members derivative in the conf.py file was that now we have all these extra documented methods (see BaseFilter docs):

[Bibo-Joshi]

Since so for Bot.eq is not explicitly documented, it might be wise to adjust this before adding documentation would make this a (very minor) breaking change. What do you think?

I agree, should be updated, though we will need to add an _id_attrs for Bot as well, what should that include?

_id_attrs unfortunately don't work for the Bot class, as we're comparing with the bot propery. However, that's only cached once Bot.initialize is called, so not on __init__. Replacing return False with return super().__eq__(other) (and adjusting tests) would be enough IMO.

Also telegram.ext.updater.rst still has the :special-members: in it, should be deleted.

good catch 👍

Also I believe that a side effect of adding the special-members derivative in the conf.py file was that now we have all these extra documented methods (see BaseFilter docs):

adding object to :inherited-members in filters.rst should exlude these :)

[Bibo-Joshi]

Also I believe that a side effect of adding the special-members derivative in the conf.py file was that now we have all these extra documented methods (see BaseFilter docs):

adding object to :inherited-members in filters.rst should exlude these :)

I see that there is also __weakref__ in Bot :/ This is getting messier than I thought and it's also somewhat hard to catch … at least with 10min trial & error I didn't find a very good solution yet …