Skip to content

Commit d2d7967

Browse files
kyranetfavna
authored andcommittedNov 18, 2023
docs(Command): update fullCategory's outdated docs
1 parent e441115 commit d2d7967

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed
 

‎src/lib/structures/Command.ts

+7-4
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,14 @@ export class Command<PreParseReturn = Args, Options extends Command.Options = Co
5353
public detailedDescription: DetailedDescriptionCommand;
5454

5555
/**
56-
* The full category for the command. Either an array of strings that denote every (sub)folder the command is in,
57-
* or `null` if it could not be resolved automatically.
56+
* The full category for the command, can be overridden by setting the {@link Command.Options.fullCategory} option.
57+
*
58+
* If {@link Command.Options.fullCategory} is not set, then:
59+
* - If the command is loaded from the file system, then this is the command's location in file system relative to
60+
* the commands folder. For example, if you have a command located at `commands/General/Information/info.ts` then
61+
* this property will be `['General', 'Info']`.
62+
* - If the command is virtual, then this will be `[]`.
5863
*
59-
* If this is `null` with how you set up your code then you can overwrite how the `fullCategory` is resolved by
60-
* extending this class and overwriting the assignment in the constructor.
6164
* @since 2.0.0
6265
*/
6366
public readonly fullCategory: readonly string[];

0 commit comments

Comments
 (0)
Please sign in to comment.