Skip to content

v0.9.0

Choose a tag to compare

@KevinEady KevinEady released this 10 Jan 09:29
· 58 commits to master since this release
9139386

This release adds support for displaying documentation inside hover and signature help for symbols (variables, enums, user and module functions, ...). Documentation for module functions come from the polserver XML documentation, which the extension will automatically download. Documentation for user-provided symbols (variables, functions, ...) will come from comments above the definition.

Documentation shows on both hover...

user-function-docs

module-function-docs

... as well as signature help

signature-help-docs

Extension Configuration

The polserver commit ID used for module function documentation is by default based off the POL executable commit ID, and can be overridden with a different commit ID from User Preferences with the escript.polCommitId key. Additionally, documentation from user comments will not be displayed for module functions by default, as the XML documentation is more feature-rich. Displaying user comments can be enabled using the escript.showModuleFunctionComments key. Both settings can be changed either in the JSON preferences or the Settings panel:

image

What's Changed

Full Changelog: v0.8.0...v0.9.0