Parse `doc` to retrieve `bpy.types.Property` description attributes when using `BLField` #14

New issue

Open

opened 2024-05-04 16:52:14 +02:00 by so-rose · 0 comments

so-rose commented

2024-05-04 16:52:14 +02:00

Owner

Encourage the node designer to use docstrings, which double as "real" documentation, to describe all BLFields. The beautiful side effect of this is that the Blender documentation will

We can use griff (https://pypi.org/project/griffe/) for this. The only worry would be the performance of mass-parsing __doc__s on every startup; perhaps a services model could act as a "provider" of structured information about the code?

Encourage the node designer to use docstrings, which double as "real" documentation, to describe all `BLField`s. The beautiful side effect of this is that the Blender documentation will We can use `griff` (https://pypi.org/project/griffe/) for this. The only worry would be the performance of mass-parsing `__doc__`s on every startup; perhaps a `services` model could act as a "provider" of structured information about the code?