Class PineDocString

constructor

• new PineDocString(): PineDocString

• Returns PineDocString

Editor

functionPattern

typePattern

docstring

• docstring(): Promise<void>

• Reads the selected code in the editor and generates the appropriate docstring.

  Returns Promise<void>

generateDocstring

• generateDocstring(match): Promise<undefined | string>

• Generates a docstring for a given function code.

  Parameters

  • match: string

    The string of the function's code.

  Returns Promise<undefined | string>

  The generated docstring.

generateTypeDocstring

• generateTypeDocstring(match): Promise<string>

• Generates a docstring for a given type declaration code.

  Parameters

  • match: string

    The string of the type's code.

  Returns Promise<string>

  The generated docstring.