Docs: Categories in Event Reference #80

New Issue

2021-09-29T20:54:52Z

rudes commented

2021-09-29 20:54:52 +00:00

(Migrated from github.com)

Summary

Event Reference in api.rst is a bit difficult to navigate on docs, using categories can clean that up.

What is the feature request for?

The documentation

The Problem

Walking through the Event Reference section of https://enhanced-dpy.readthedocs.io/en/latest/api.html#event-reference is difficult now that we have a million discord events.

The Ideal Solution

Make sub categories like Role, Message, Networking under Event Reference (something like Voice Related Section)

something like:

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

Messages
~~~~~~~~~~~~~~~

.. function:: on_message(message)
.. function:: on_message_delete(message)

The Current Solution

No response

Additional Context

No response

### Summary Event Reference in api.rst is a bit difficult to navigate on docs, using categories can clean that up. ### What is the feature request for? The documentation ### The Problem Walking through the Event Reference section of https://enhanced-dpy.readthedocs.io/en/latest/api.html#event-reference is difficult now that we have a million discord events. ### The Ideal Solution Make sub categories like Role, Message, Networking under Event Reference (something like Voice Related Section) something like: ```rst Event Reference --------------- Messages ~~~~~~~~~~~~~~~ .. function:: on_message(message) .. function:: on_message_delete(message) ``` ### The Current Solution _No response_ ### Additional Context _No response_

IAmTomahawkx commented

2021-09-29 21:01:06 +00:00

(Migrated from github.com)

Feel free to pr this, currently we've got tons that has a higher priority, this is more of a QOL thing

👍 1

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: matthew/enhanced-discord.py#80