Grasshopper python docstring format

Grasshopper
1

I note that the docstrings in the Python script components seem to be following either the Google or NumPy/SciPy formats. Can anyone tell me which one this is? (@piac ?)

Thanks

2

Hi Andrew,

Let’s call it McNeel style. It’s roughly based on Google’s. There’s also a Remarks: section. The keywords it picks up are in this switch statement.

You should just follow exactly the stub that is there. There’s more or different style than in either one, because we have slightly more info. You can add the type between parentheses, but it’s currently just copied to the documentation.

Thanks,

Giulio

–
Giulio Piacentino
for Robert McNeel & Associates
giulio@mcneel.com

1 Like