# Script documentation convention and "intellisense"

**URL:** <https://forum.inductiveautomation.com/t/script-documentation-convention-and-intellisense/20659>\
**Category:** Ignition\
**Tags:** scripting, ignition79\
**Created:** [November 8, 2018, 8:25am UTC](https://forum.inductiveautomation.com/t/script-documentation-convention-and-intellisense/20659 "2018-11-08T08:25:18Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![agn](https://avatars.discourse-cdn.com/v4/letter/a/eb8c5e/32.png) [@agn](https://forum.inductiveautomation.com/u/agn)\
**Post date:** [November 8, 2018, 8:25am UTC](https://forum.inductiveautomation.com/t/script-documentation-convention-and-intellisense/20659/1 "2018-11-08T08:25:18Z")

</div>

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.

```auto
system.alarm.acknowledge()
```

```auto
project.MyScripts.MyFunction()
```

```auto
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]

---

<div class="post-metadata">

**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\
**Post date:** [November 8, 2018, 2:34pm UTC](https://forum.inductiveautomation.com/t/script-documentation-convention-and-intellisense/20659/2 "2018-11-08T14:34:26Z")

</div>

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

Feel free to submit this at [https://ideas.inductiveautomation.com](https://ideas.inductiveautomation.com) as well.

---

<div class="post-metadata">

**Author:** ![ToMakPo](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/tomakpo/32/23875_2.png) [@ToMakPo](https://forum.inductiveautomation.com/u/ToMakPo)\
**Post date:** [April 28, 2023, 9:00am UTC](https://forum.inductiveautomation.com/t/script-documentation-convention-and-intellisense/20659/3 "2023-04-28T09:00:29Z")

</div>

Was this ever implemented?

---

<div class="post-metadata">

**Author:** ![Kevin.Herron](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/kevin.herron/32/7259_2.png) [@Kevin.Herron](https://forum.inductiveautomation.com/u/Kevin.Herron)\
**Post date:** [April 28, 2023, 1:12pm UTC](https://forum.inductiveautomation.com/t/script-documentation-convention-and-intellisense/20659/4 "2023-04-28T13:12:34Z")

</div>

As of 8.1.18 docstrings should be supported in some capacity... @paul-griffith ?

---

<div class="post-metadata">

**Author:** ![paul-griffith](https://sea1.discourse-cdn.com/inductiveautomation/user_avatar/forum.inductiveautomation.com/paul-griffith/32/37249_2.png) [@paul-griffith](https://forum.inductiveautomation.com/u/paul-griffith)\
**Post date:** [April 28, 2023, 3:34pm UTC](https://forum.inductiveautomation.com/t/script-documentation-convention-and-intellisense/20659/5 "2023-04-28T15:34:03Z")

</div>

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.