Accessing Help in a VEX VS Code Project

You can access documentation for VEXcode commands through the VEX Command Help or tooltip hint features in the VS Code VEX Extension.

Accessing VEX Command Help

Python command in the VS Code editor has been highlighted with the cursor.

Highlight the text of the command that you want to know information about, then right-click on the selected text.

Context menu for the Python command has been opened and the VEX Command Help option is highlighted.

Select VEX Command Help in the context menu.

VEX Command Help page is open, and it shows information about and examples of the Spin Python command.

If a match to the highlighted text is found, the VEX Command Help window will open to the relevant documentation.

VS Code search bar with a Quick Pick List of matching VEX Python commands in VEX Command Help to help narrow down the user's search.

If there are multiple matches to the selected text, the VEX Command Help drop-down menu will appear with a filtered list of relevant functions.

VS Code search bar with a Quick Pick List of matching VEX Python commands in VEX Command Help. The term Spin has been typed into the search bar and all commands containing that term are shown.

Enter the keyword of the specific command in the text box to filter the relevant commands.

VS Code search bar with the term Spin typed into the search bar and all commands containing that term shown. The motor.spin(FORWARD) Python command is highlighted.

Select the command from the list to open its VEX Command Help.

VEX Command Help page is open, and it shows information about and examples of the Spin Python command.

The VEX Command Help window will open with the documentation for the selected command.

Tooltip Hints

Mouse is hovering over a Python command in the VS Code editor that reads PERCENT.

Hover the mouse over the text you want more information about.

Tooltip hint of the PERCENT parameter that opens after a term is hovered over. The tooltip in this example reads PERCENT, constant, PercentUnits, A percentage unit that represents a value from 0% to 100%.

The tooltip will appear with information on what is being hovered over.

For more information, help, and tips, check out the many resources at VEX Professional Development Plus

Last Updated: