You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Porting the python docstring over to the c stub output is handy for maintaining even more documentation synchronization.
Eg.
"""
This module is developed for adding new functionality to upython
We want tabs
"""
Should translate to
/*
This module is developed for adding new functionality to upython
We want tabs
*/
There could be a case for adding ustubby generic output to the generated file so that the source is not lost
/*
This module is developed for adding new functionality to upython
We want tabs
This file was auto-generated using uStubby.
Please see https://github.com/pazzarpj/micropython-ustubby
*/
The text was updated successfully, but these errors were encountered:
TODO: Put the module description from the C code into the target compiled micropython module.
DESCRIPTION in sourse stub module.py -> uStubby -> DESCRIPTION in module.c ->micropython make -> DESCRIPTION in target module.DOC
The target compiled module should have a 'DESCRIPTION' like stub modules from the zip with using the help() command:
>>> import module_description_1
>>> help(module_description_1)
Help on module module_description_1:
NAME
module_description_1 - This is one-line description of module.
FUNCTIONS
example() -> None
no matter here
FILE
d:\owl\sova\python_source_code\esp32_server\ustubby\module_description_1.py
and
>>> import module_description_2
>>> help(module_description_2)
Help on module module_description_2:
NAME
module_description_2
DESCRIPTION
This is multi-line description of module.
This is multi-line description of module.
FUNCTIONS
example() -> None
no matter here
no matter here
FILE
d:\owl\sova\python_source_code\esp32_server\ustubby\module_description_2.py
Hi Ihor,
I'm not sure how to compile the help into the c extension.
The original intent of this module was to use the type annotated python and run something like OpenAPI across it to generate the documentation for the modules.
Porting the python docstring over to the c stub output is handy for maintaining even more documentation synchronization.
Eg.
Should translate to
There could be a case for adding ustubby generic output to the generated file so that the source is not lost
The text was updated successfully, but these errors were encountered: