Script documentation convention and "intellisense"

Ignition
,
1

Is it possible to add non-native scripts to the auto-complete list?
I do believe I saw a topic similar to this one, but I’m unable to locate it.

system.alarm.acknowledge()
project.MyScripts.MyFunction()
shared.MyScriptPackage.MyScript()

Currently I have been using the following documentation convention:

[code] def myDocumentationTest(myParameter, mySecondParameter):
“”"
myDocumentationTest(myParameter, mySecondParameter)

Returns true/false based on liability of convention structure.

    Parameters:
    -----------
    myParameter : string
        convention style (ex. pyCharm)
    mySecondParameter : string
        We need two parameters. Use it.
    """

[/code]

2

It’s not possible right now but this is a neat idea.

Feel free to submit this at https://ideas.inductiveautomation.com as well.

2 Likes
3

Was this ever implemented?

4

As of 8.1.18 docstrings should be supported in some capacity... @PGriffith ?

5

Smarter autocomplete for system functions happened in 8.1.18.
Project script autocompletion landed in 8.1.19.
Parsing docstrings on user-provided scripts is hopefully going to land in the next few releases; initial effort will be on consuming "Google-format" docstrings, to offer richer autocomplete.
Some other, more significant overhauls will have to wait for 8.3.

5 Likes