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

Add an optional way to prevent docstring consumption #237

Open
jubbers opened this issue Jan 4, 2024 · 1 comment
Open

Add an optional way to prevent docstring consumption #237

jubbers opened this issue Jan 4, 2024 · 1 comment

Comments

@jubbers
Copy link

jubbers commented Jan 4, 2024

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.

@jubbers jubbers changed the title Add an optional way to prevent Docstring consumption Add an optional way to prevent docstring consumption Jan 4, 2024
@jubbers
Copy link
Author

jubbers commented Jan 5, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant