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 support for more docstrings styles #1139

Open
Snipy7374 opened this issue Dec 12, 2023 · 0 comments · May be fixed by #1140
Open

Add support for more docstrings styles #1139

Snipy7374 opened this issue Dec 12, 2023 · 0 comments · May be fixed by #1140
Labels
feature request Request for a new feature

Comments

@Snipy7374
Copy link
Collaborator

Summary

Currently disnake is able to parse numpy style docstrings only.

What is the feature request for?

The core library

The Problem

Users in other IDEs (where the numpy style is not supported) that are using functions docstrings to describe an app command can't see their functions docstrings as they should be, obliging them to either renounce to describing app commands using docstrings or renounce to read docstrings using them for what they should be used (documentation)

The Ideal Solution

Implement a parser to parse the three main docstring styles present in python: reST style, Google style, numpy style (already implemented)

The Current Solution

Don't use functions docstrings to describe app commands and options.

Additional Context

No response

@Snipy7374 Snipy7374 added the feature request Request for a new feature label Dec 12, 2023
@Snipy7374 Snipy7374 linked a pull request Dec 12, 2023 that will close this issue
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Request for a new feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant