feat: revamp and refactor courses to support multiple aggregation views #152
No reviewers
Labels
No labels
beginner friendly
bug
chore
documentation
duplicate
feature
help wanted
invalid
needs-triage
question
size/L
size/M
size/S
size/XL
size/XS
urgent
wontfix
No milestone
No project
No assignees
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
ScottyLabs/dalmatian!152
Loading…
Reference in a new issue
No description provided.
Delete branch "refs/pull/152/head"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Features:
Refactors:
EmbedPaginatorto work with other components, such as select menusoperatorParser.tsfrommodulestoutils(closes #96)Performance:
I agree, in another PR we should move these courses commands into
src/courses, and then have the command handler recursively look through folders to find themFor these extremely small functions, I think it's fine to go in
index.ts, but if we accumulate more course-related things we need to put inutilsthen I'd prefer making a different file tooFor the sake of user usability, we may not want to expand the commands just to recompress them again at a later date, in my opinion. Perhaps we can get the PR for this before we deploy this one
This is intentional. We want the commands to be
/fce,/course,/syllabus, etc rather than subcommands/courses fce,/courses course-info, etc, as discussed in #92.It would be a bad change in user-space if it left
/courses, and then later came back with/courseshttps://lkml.org/lkml/2012/12/23/75
I think there is a misunderstanding - we are permanently moving from
/courses fceto/fce. There will not be a/coursescommand in future versions of the bot. Whether or not we want to change the internal folder structure to reflect this is up for discussion, but I believe these courses subcommands should be changed into separate commands moving forwardWhy would it be bad to have two versions of the command (e.g.
/courses fceand/fce)? It would allow users to more easily discern all of the course commands available but still give a shortcut command.Providing two ways to do the same thing adds clutter to the commands list and will cause confusion about what is the difference between the two.
/fceis already descriptive; we don't need to categorize them based on whether it is from courses or not.Personally I'm on the wagon of putting it all under courses for the sake of macroscopic organization across the bot. I think effectively categorizing functions within an overarching command gives a cleaner UX. For example, the user will be shown all the course commands when they type /course, so they are implicitly informed of all functionality. You can end up with a "lost command" or confusion on functionality if you spread it out. Just my 2 cents tho
Additionally, my understanding of #92 is to put sub command code in different files in a shared parent folder for the command, not separate out the commands themselves.
For what it's worth, we can still have subcommands in individual folders without registering the path as that command.
Yep this was what I was thinking
We can put a poll up for
/fcevs/courses fceif you guys wantThat's a good idea, we should do that.
Will add an alias feature and move commands back to thecoursesfolderHeld for further discussion
Decided on Discord