Displaying parameters' descriptions in guided deployments
- Dominant language
- Python
- Stars
- 6.7k
- Forks
- 1.2k
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 52
Description
### Describe your idea/feature/enhancement
When using `sam deploy --guided`, I wish SAM would display parameters' descriptions (if any) like some of the built-in options. This will highly simplify guided deployments, especially when the one who wrote the template is not the one who deploys it.
e.g. for the built-in _Confirm changes_ option, SAM shows:
#Shows you resources changes to be deployed and require a 'Y' to initiate deploy
**Confirm changes before deploy** [Y/n]:
### Proposal
When running `sam deploy --guided` with this template parameter-
```
Parameters:
MyPar:
Type: String
Description: Example description for parameter MyPar
Default: MyParVal
```
SAM will show-
#Example description for parameter MyPar
**Parameter MyPar** [MyParVal]:
Things to consider:
Descriptions should only be shown when exist.
Contributor guide
Assessment
This issue has not been assessed yet.