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

Parse option descriptions from docstrings #23

Open
Bluenix2 opened this issue Jun 28, 2022 · 0 comments
Open

Parse option descriptions from docstrings #23

Bluenix2 opened this issue Jun 28, 2022 · 0 comments
Labels
feature New addition to the library wumpy-interactions

Comments

@Bluenix2
Copy link
Collaborator

Bluenix2 commented Jun 28, 2022

Summary

As yet another API to interactions, the library could parse the docstring for description for each option. Because of its simplicity this could be done using regex, similar to how Nextcord has implemented this.

Refer to the specification for Numpydoc, Sphinx documentation and this Google docstrings example.

The code for this would be placed inside of _process_callback() together with the existing parsing of docstrings.

@Bluenix2 Bluenix2 added feature New addition to the library wumpy-interactions labels Jun 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New addition to the library wumpy-interactions
Projects
Status: 📁 - Planning
Development

No branches or pull requests

1 participant