Update deploy documentation to add wait arg

[rtorrente]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Description

Wait argument has been added to container deploy in 2022 #2681 but the documentation still not mention this (https://github.com/scaleway/scaleway-cli/blob/master/docs/commands/container.md#deploy-a-container)

I just tested and the wait works well.

Maybe the doc can be updated if the feature is officially supported ?

[Mia-Cross]

Hello @rtorrente,

Thank you for your feedback.

As you noticed, --wait is absent from the container.md file because it is considered a flag and not an argument, and as of today, we only display arguments in the .md generated documentation files.
However it is displayed in the --help command:

$ scw container container deploy --help
Deploy a container associated with the specified ID.

USAGE:
  scw container container deploy <container-id ...> [arg=value ...]

ARGS:
  container-id      UUID of the container to deploy
  [region=fr-par]   Region to target. If none is passed will use default region from the config (fr-par | nl-ams | pl-waw)

FLAGS:
  -h, --help   help for deploy
  -w, --wait   wait until the container is ready

GLOBAL FLAGS:
  -c, --config string    The path to the config file
  -D, --debug            Enable debug mode
  -o, --output string    Output format: json or human, see 'scw help output' for more info (default "human")
  -p, --profile string   The config profile to use

We understand that it might be confusing, so we are considering adding flags to the generator for the documentation to be as clear as possible, but it is a bigger task than we initially thought, so we re-prioritized this issue for now.

Thanks again for taking the time to give us feedback, we really appreciate it !