Cog-Creators/Red-DiscordBot

[Permissions] Add comments to 'acl getserver' yaml displaying what the ID relates to

Open

#5,115 opened on Jun 2, 2021

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (4,337 stars) (2,317 forks)batch import
Category: Cogs - PermissionsHelp WantedStatus: AcceptedType: Feature

Description

Type of feature request

Command

Description of the feature you're suggesting

With [p]permissions acl getserver I think it'd be handy if YAML comments could show what the IDs relate to, as a lot of the time I end up looking them up manually. Server roles at the least would be nice, but it could extend to members too.

Anything else?

No response

Contributor guide

Tech stack
python
Domain
backend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
PythonRed DiscordBot development setupYAML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate the command `[p]permissions acl getserver` in the Red DiscordBot codebase. The YAML output is generated in a file related to permissions, such as `redbot/cogs/permissions/`. Look for how role IDs and member IDs are mapped to names using the bot's cache or API calls. Add YAML comments that show the role names next to role IDs and optionally member names next to user IDs. Check existing comments in the issue for any hints about implementation specifics.