Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation to reflect the category property in commands #1465

Open
ccrenfroe opened this issue May 17, 2023 · 0 comments
Open

Update documentation to reflect the category property in commands #1465

ccrenfroe opened this issue May 17, 2023 · 0 comments
Labels
t: request Suggestion to add new or change existing content

Comments

@ccrenfroe
Copy link

ccrenfroe commented May 17, 2023

Is your feature request related to a problem? Please describe.

The reloading commands guide gives a good code snippet to effectively reload commands if they are all on the same file level, however it doesn't work if commands are nested in subfolders.

To build the correct file path, you will need the file name. You can use command.data.name for doing that. This does not however take into account how this would work if you had subdirectories as described earlier in the guide at Command Handling.

Additionally, reload.js handles the logic differently, using the category property to build the filepath instead. Each command seems to have this property, although the guide does not highlight this on the reloading commands or the command handling pages

Describe the solution you'd like

I believe the best solution would be to update the documentation in both command categories and reloading commands to address the category property that is added to each command when implementing the subfolders approach.

Describe alternatives you've considered

No response

Additional notes

Please let me know if more info is needed or I am erroneous in my request. :)

@ccrenfroe ccrenfroe added the t: request Suggestion to add new or change existing content label May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t: request Suggestion to add new or change existing content
Projects
None yet
Development

No branches or pull requests

1 participant