Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature] Generate parameter description with possbile values. #1302

Open
BethanyZhou opened this issue Jan 29, 2024 · 2 comments
Open

[Feature] Generate parameter description with possbile values. #1302

BethanyZhou opened this issue Jan 29, 2024 · 2 comments

Comments

@BethanyZhou
Copy link
Contributor

If we have a parameter with PSArgumentCompleter('A', 'B') or ArgumentCompleter('A', 'B'), it's nice to list its possible values in its parameter description in help doc.

@isra-fel
Copy link
Member

isra-fel commented Feb 1, 2024

The way argument completer is decribed in help doc should be different from validate set. We should avoid giving user the empression this is all the options.

@isra-fel
Copy link
Member

isra-fel commented Feb 1, 2024

Nice to have: if swagger description already has possible values, it's best we don't say it again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants