pycord icon indicating copy to clipboard operation
pycord copied to clipboard

Add categories for event reference (docs)

Open Sengolda opened this issue 2 years ago • 7 comments

Summary

Put events in sub-categories in the event-reference in api.html

What is the feature request for?

The documentation

The Problem

It's kind of hard not knowing which events fall in which categories, I feel it would be easier if they were in sub-categories.

The Ideal Solution

Make subcategories for each type of events like Roles, Messages, etc

Like

Event Reference
---------------------------

Message Event Reference
~~~~~~~~~~~~~~~

.. autofunction:: on_message
.. autofunction:: on_message_delete
.. autofunction:: on_message_edit

The Current Solution

No response

Additional Context

No response

Sengolda avatar Nov 13 '21 17:11 Sengolda

Would love to see this added, it's been something I've been thinking about for a while

UP929312 avatar Nov 15 '21 16:11 UP929312

Good idea Seng00lda

zeffo avatar Nov 16 '21 13:11 zeffo

cover foto is will be added

ghost avatar Nov 16 '21 23:11 ghost

How about events that are related to message but doesn't return message as a parameter. Example: discord.on_raw_bulk_message_delete(payload) Which is a message-related function but returns payload. Where would you categorise this

TheReaper62 avatar Dec 05 '21 03:12 TheReaper62

I would put it in the Message Event reference, as well as a separate category for raw events

zeffo avatar Dec 05 '21 10:12 zeffo

What if we could do message Event / raw Event reference and mention them all in same?

Akashdeep122 avatar Jan 03 '22 12:01 Akashdeep122

Is this still open? If so, how should it be documented?

hi-im-morgan avatar Jul 22 '22 10:07 hi-im-morgan