You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
While we can use the ansible module snippets to see the possible parameters of a module and their documentation, it is somewhat tedious to invoke the snippet and then have to delete all the comments and extra params that were not necessary. The existing hover tooltips just provide a link to the primary ansible online documentation; which while nice, leads to a lot of back & forth between the browser and VS Code when investigating a module for various options.
An improvement would be to add the list of possible parameters for a module (with some designation of mandatory/optional). Additionally being able to hover over a specific parameter and seeing the documentation for the specific allowable values or notes for that parameter would be great.
The text was updated successfully, but these errors were encountered:
@zswanson thanks for the feedback and suggestion. The feature sounds good to save user's effort to finish a snippet. While we need to figure out 2 things:
weather it's acceptable to majority users to remove optional parameters from code snippet.
what's different on parameters' description in code snippet and in document link.
Will update here if any result.
for add list of possible parameters for a module item. actually we're working on providing workable samples for modules so that user could direct run the samples. the feature will be coming soon maybe in next month.
hover over on specific parameter to get allowed value, you could get the info in comments of current code snippets. and choice will be showed in comments also. like below code snippet for docker_login module:
reauthorize: yes # not required. choices: yes;no. Refresh exiting authentication found in the configuration file.
While we can use the ansible module snippets to see the possible parameters of a module and their documentation, it is somewhat tedious to invoke the snippet and then have to delete all the comments and extra params that were not necessary. The existing hover tooltips just provide a link to the primary ansible online documentation; which while nice, leads to a lot of back & forth between the browser and VS Code when investigating a module for various options.
An improvement would be to add the list of possible parameters for a module (with some designation of mandatory/optional). Additionally being able to hover over a specific parameter and seeing the documentation for the specific allowable values or notes for that parameter would be great.
The text was updated successfully, but these errors were encountered: