search

jmosbacher / pydantic-panel

Edit pydantic models with widgets from the awesome Panel package
MIT License
24 stars 3 forks source link

Improve docstrings to help users #5

Closed MarcSkovMadsen closed 2 years ago

MarcSkovMadsen commented 2 years ago

Docstrings can help users or contributors like me working in VS Code use the package much more efficiently.

Examples

https://github.com/jmosbacher/pydantic-panel/blob/040a55adf788591904b8a117a9cb1ab183169057/pydantic_panel/pane.py#L39

image

https://github.com/jmosbacher/pydantic-panel/blob/master/pydantic_panel/__init__.py

image

MarcSkovMadsen commented 2 years ago

For me it would helpful with some documentation in the style of the top-level module __init__.py file in Panel and any Panel widget __init__.py file.