Multiline Description in New Script Component

Scripting
,
9

@Mahdiyar @AndersDeleuran @Helvetosaur

Okay here is the YT

RH-79236 Script component to extract description from docstrings

I’d appreicate if any of you can give me a short list of expectations/wishes for the docstrings. Let’s add on to this list:

  • Consistent docstring convention for all languages
  • Docstring to show parameter name, pretty-name, description, type (hint)
  • Component updates docstring when parameters change
  • Component updates its own parameters from docstring. Pasting a script into a component should automatically update the component parameters (This currently works with SDK style scripts from RunScript signature)
<main description; multiline>

    Inputs:
        <name>[<type; optional>]: <description; multiline>

    Outputs:
        <name>[<type; optional>]: <description; multiline>

    Author: <author>
    Version: <script-version>
    Rhino: <min-rhino-required>
3 Likes