search

serenity-rs / poise

Discord bot command framework for serenity, with advanced features like edit tracking and flexible argument parsing
MIT License
644 stars 114 forks source link

Add an optional way to prevent docstring consumption #237

Open saint-justin opened 9 months ago

saint-justin commented 9 months ago

Currently, slash command docstrings are consumed by Poise's slash command macro to be used for Discord helper text content. While this is expected behavior, it prevents packages from using that same info from being consumed by cargo doc to generate documentation for commands built with the slash command macro.

It would be fantastic to have the option to have some delineation between the two types of comments to allow cargo doc to generate documentation as usual or in a slightly adjusted way.

TL;DR: It would be nice to be able to use docstrings for both help information in Discord and for cargo doc outputs somehow.

saint-justin commented 9 months ago

See also the snippet here for the where this is happening per Kangalio.