Open PGimenez opened 8 months ago
That sounds like a big step forward for the docs!🚀
Actually, we could also extract examples from Quasar. Together with my parse_vue_html()
we could most probably build decent examples, which would , however, require some manual steps.
I've just submitted a PR that supports Dicts and Vectors as values for arguments.
If that is in place, we can replace Object
with Dict
and Array
with Vector
.
I've created a script that automatically generates docstrings for the StippleUI components from the quasar docs. Repository here: https://github.com/GenieFramework/StippleUIDocstringGen
The steps are:
The result is something like this:
This is the complete docstring that we'd have for each function in the SippleUI API. Now, the question is how to add it. We could simply add it in the source, or we could write some macro to include the docstring with something like
What would you suggest @essenciary @hhaensel ?
Also, note that this would only replace the docstrings for components that are already in the gallery since these are the ones with usage examples.