Acknowledged
4 months ago

SDK: provide source files with "skeleton" code / documentation for all API symbols to support features such as: CTRL/CMD-click on symbol to go method signature/docs, and viewing docs in VS Code (instead of browser)

Currently:

- if you CTRL/CMD-click on an API symbol (e.g. AppBase.getApp()) in an attempt to go to the definition, nothing happens. This is expected, since there is no definition to go to.

- if you hover over an API symbol and click on an API symbol in the resulting hover info, the local SDK documentation opens in a web browser. This is ok, but it's also bit heavyweight. It would be great if the dev could see the documentation / method signature in VS Code

Both of these use cases could be fulfilled if the Connect IQ SDK provided a set of "skeleton" source files for all API symbols containing method signatures, member variable definitions, and documentation. This source could also include links to the local SDK documentation, if the dev really wants to see it in a browser.

I *think* this is how it works for languages like Java, TypeScript and python.

FlowState
Parents
  • 4 months ago

    I checked how python works.

    - If you hover over a reference to a library function or built-in, the function signature and doc are displayed in a "hover info", as in Monkey C, but none of the symbols in the hover info are clickable, so Monkey C is better in this regard

    - if you CMD/CTRL-click a library function where the actual source is available, obviously you will be taken to the real definition. [Obviously doesn't apply to Monkey C, where we don't expect to see the source code for API functions.]

    - if you CMD/CTRL-click on a built-in [or lib function that's a wrapper around a built-in] - where the real source is *not* available, you will be taken to a typeshed file which has the function signature

    The ability to open the rich documentation in the browser is a great feature. and I don't want to see that go away. It would just be nice if you could CMD/CTRL-click on API symbols and have something reasonable happen [preferably staying within VS Code, rather than opening the browser.]

Comment
  • 4 months ago

    I checked how python works.

    - If you hover over a reference to a library function or built-in, the function signature and doc are displayed in a "hover info", as in Monkey C, but none of the symbols in the hover info are clickable, so Monkey C is better in this regard

    - if you CMD/CTRL-click a library function where the actual source is available, obviously you will be taken to the real definition. [Obviously doesn't apply to Monkey C, where we don't expect to see the source code for API functions.]

    - if you CMD/CTRL-click on a built-in [or lib function that's a wrapper around a built-in] - where the real source is *not* available, you will be taken to a typeshed file which has the function signature

    The ability to open the rich documentation in the browser is a great feature. and I don't want to see that go away. It would just be nice if you could CMD/CTRL-click on API symbols and have something reasonable happen [preferably staying within VS Code, rather than opening the browser.]

Children
No Data