Fix inlayHints.callArgumentNames documentation: update from boolean to enum #8921
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation for
python.analysis.inlayHints.callArgumentNamesincorrectly described it as a boolean setting withtrue/falsevalues, but this setting was changed to an enum in VS Code v1.83.Problem
Users were seeing inaccurate documentation that showed:
However, according to the v1.83 release notes, this setting now accepts three enum values for more granular control.
Solution
Updated the documentation to accurately reflect the current behavior:
falsetooffoff,partial, andallinstead of boolean valuesoff: No inlay hints are shownpartial: Hints are disabled for positional-only and keyword-only parametersall: Hints are shown for all parametersThe updated documentation follows the established pattern used by other enum settings in the same file and provides users with accurate information about this Pylance feature.
Fixes the issue reported where the documentation didn't match the actual setting behavior.
Fixes #8920
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.