While compiling a ghpy component, nomatter what I write as the description of the input and outputs, when checking the compiled component help, it still says ‘script input/output xxxx variable’ for the respective variables instead of the documented string. Must be missing something, is there a specific syntax for documenting a ghpy component help?
Any help here? Am I doing something wrong or is the required functionality to pick up the documentation strings not working correctly?
Hi Florin
with this syntax, I get the expected result:
Does it help?
Giulio
Giulio Piacentino
for Robert McNeel & Associates
giulio@mcneel.com
Giulio,
Many thanks for pointing it out. I found that it doesn’t work right out of the box. When I switch to component compilation mode and just replace the default strings and compile, then it won’t display the correct string. What I did to make it work is remove the documentation string block out of the function and place it on top of the document. Then it worked after recompiling. After it worked like that, I put the string block back inside the function and it worked again. Strange.
Well, switching is not free. The component does some tweaking to the code, but it does not move the documentation string right to the top.
Giulio
Giulio Piacentino
for Robert McNeel & Associates
giulio@mcneel.com
Got it,
Thanks Giulio!