Hints Viewer

This feature enhances your development experience by providing helpful hints for errors detected in your code.

idf.py will try to suggest hints on how to resolve errors. It works with a database of hints stored in $IDF_PATH/tools/idf_py_actions/hints.yml and the hints will be printed if a match is found for the given error.

Hover Over Errors for Hints

When you hover over errors in the text editor, if the error matches one listed in our hints.yml file, a hint is displayed.

../_images/hover.gif

Bottom Panel for Hints

  1. Automatic Updates: The ESP-IDF bottom panel automatically updates to display hints based on the errors in your currently opened file.

../_images/bottom_panel.png

  1. Manual Search: You can manually search for hints by copy pasting errors.

../_images/manual_search.gif