11# Python Inlay Params
22
33![ Build] ( https://github.com/WhiteMemory99/intellij-python-inlay-params/workflows/Build/badge.svg )
4- ![ Downloads] ( https://img.shields.io/jetbrains/plugin/d/19538-python-inlay-params )
4+ ![ Version] ( https://img.shields.io/jetbrains/plugin/v/19538 )
5+ ![ Rating] ( https://img.shields.io/jetbrains/plugin/r/rating/19538 )
6+ ![ Downloads] ( https://img.shields.io/jetbrains/plugin/d/19538 )
57[ ![ License: MIT] ( https://img.shields.io/badge/License-MIT-yellow.svg )] ( https://opensource.org/licenses/MIT )
68
79## Quick Installation
2022## Description
2123
2224<!-- Plugin description -->
23- This plugin _ (quite decently)_ implements inlay parameter hints for ** Python** .
25+ This plugin _ (quite decently)_ implements inlay parameter hints for ** Python** .
26+ In addition, you can enable type annotation hints for variables and function return types.
2427
2528### Supported expressions
2629
@@ -38,12 +41,30 @@ Pretty much any expression is supported:
3841
3942## Settings
4043
41- The plugin can be disabled entirely in the IDE settings:
44+ ### Parameter hints
45+
46+ To disable them entirely, follow this path:
4247
4348<kbd >Settings</kbd > -> <kbd >Editor</kbd > -> <kbd >Inlay Hints</kbd > -> <kbd >Parameter names</kbd > -> <kbd >Python</kbd >
4449
45- There are also more detailed settings in the same section that let you control the behavior of the plugin.
50+ But you can also switch specific parts in that menu: ` Class hints ` , ` Function hints ` , and ` Lambda hints ` to
51+ enable/disable them individually.
52+
53+ ### Type annotation hints (BETA)
54+
55+ To disable them entirely, follow this path:
56+
57+ <kbd >Settings</kbd > -> <kbd >Editor</kbd > -> <kbd >Inlay Hints</kbd > -> <kbd >Types</kbd > -> <kbd >Python</kbd >
58+
59+ There are two main options under this partition: ` Type annotations ` and ` Function return types ` .
60+ Look at the demo screenshot to see them in work.
61+
62+ ## Demo Screenshots
63+
64+ #### Parameters
65+
66+ ![ ] ( .github/readme/params_demo.png )
4667
47- ## Demo Screenshot
68+ #### Type annotations
4869
49- ![ ] ( .github/readme/plugin_demo .png )
70+ ![ ] ( .github/readme/types_demo .png )
0 commit comments