search

Lenni0451 / SpigotPluginManager

A fresh and easy to use plugin manager for spigot
MIT License
27 stars 11 forks source link

Proper command documentation #7

Closed JPenuchot closed 3 years ago

JPenuchot commented 3 years ago

None of the commands has a proper documentation, either on the Github, Spigot resource page, or Spigot command line. Makes it hard to use on remote computers.

Lenni0451 commented 3 years ago

For me as the dev the commands are all self explanatory. It would be nice if you could provide me with an example so I really know what you mean and what things are too hard to understand.

JPenuchot commented 3 years ago

For the download command for example, I couldn't figure what the plugin ID meant and how I was supposed to find it until I got an error from the command explaining it, and I wasn't 100% sure what the purpose of the filename parameter was until I looked at the code. Making the commands a bit more verbose when you don't give them any parameter would be very nice for newbies.

Lenni0451 commented 3 years ago

I added descriptions to all commands. I would be open for Feedback if it is not exactly what you imagined or I made a typo or something. grafik

Lenni0451 commented 3 years ago

Because it is actually a lot of spam in the chat I would only display it in the console

JPenuchot commented 3 years ago

Because it is actually a lot of spam in the chat I would only display it in the console

It would be more time consuming I guess but many plugins deal with that by having dedicated documentation pages with a help command, for example pm help download could provide extensive docs. However more extensive docs could be put in the Spigot resource page or the Github repo itself for those who need it.

I added descriptions to all commands. I would be open for Feedback if it is not exactly what you imagined or I made a typo or something.

It's pretty nice already! The only suggestion I'd have is adding "to the specified filename" for the download command.

Lenni0451 commented 3 years ago

I like the idea of the dedicated help command. I think I'll add it with some extended details about the commands. Could take a while because I have other things to do but I'll come back to you once I finished it.

JPenuchot commented 3 years ago

Great, thanks for your time!

Lenni0451 commented 3 years ago

I actually had enough time to finish it directly. Took some time but it should be good now. Here is a preview of the /pm download command: grafik Not all commands have a description this large because what to say about an enable/disable command

JPenuchot commented 3 years ago

Looks perfect to me! Thanks a lot :)

Lenni0451 commented 3 years ago

Great! I just pushed it. I will add another sub command and then I will create a release of the new version. I'll close this issue now because the help is done.