Skip to content

pylance compatible docstrings #155

@tcaduser

Description

@tcaduser

Before opening an issue, please create a discussion concerning your request at https://forum.devsim.org

Is your feature request related to a problem? Please describe.
VSCode Pylance cannot load docstrings from devsim, as the core module is implemented in C++, and Pylance will not read docstrings by loading the devsim shared library. It will only parse Python files or a provided .pyi file.

Additionally the docstring format from devsim would need to be reformatted to provide documentation for the function arguments.

Describe the solution you'd like

Generate a .pyi file while building from the devsim documentation.

https://github.com/devsim/devsim_documentation

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions