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.

Sign up for GitHub

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

Jump to bottom

Numpy & ReST docstrings: Remove/Ignore "optional" as types #99

Open
Masara opened this issue Apr 4, 2024 · 0 comments
Open

Numpy & ReST docstrings: Remove/Ignore "optional" as types #99

Masara opened this issue Apr 4, 2024 · 0 comments
Labels
enhancement 💡 New feature or request
Milestone
Future

Comments

@Masara
Copy link
Contributor

Masara commented Apr 4, 2024 •
edited
Loading

Is your feature request related to a problem?

Currently if class attributes in Numpy or parameters in ReST have "optional" as a type, the "optional" will be parsed as a possible type.

Desired solution

Create a PR in Griffe to filter "optional".

Additional Context (optional)

More information can be found on the fourth point of this question: mkdocstrings/griffe#258
@Masara Masara added the enhancement 💡 New feature or request label Apr 4, 2024
@lars-reimann lars-reimann added this to the Future milestone May 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement 💡 New feature or request
Projects
Library Analysis
Status: Backlog
Milestone
Future
Development

No branches or pull requests
2 participants
@Masara @lars-reimann