davebarnes97 commented on pull request #6601: URL: https://github.com/apache/geode/pull/6601#issuecomment-878591935
> > > > @albertogpz I find it confusing that the `--cancel` command option can optionally accept a boolean value, when it could be simply present or absent. What is the use case for `--cancel=false`? > > > > > > > > > I agree. It would not make sense to use --cancel=false. > > > The normal use would be to either specify --cancel or not use --cancel at all. But the `CliOption` for boolean parameters class does not offer, as far as I know, the possibility to have an options without values. > > > If you know a way to do it, please, let me know. > > > > > > Thank you for explaining that CliOption allows the boolean parameter to be specified -- that would explain why I've encountered similar constructs when documenting other gfsh commands. In my edit of the docs for this command, I will omit that complication. I find it unhelpful, particularly when trying to describe the default behavior. > > We could change the documentation of the command to say: > `[--cancel]` instead of `[--cancel(=value)?]` but the command would allow to set a value anyway. Yes, that's my plan. The user guide does not have to provide an exhaustive list of every conceivable code path. In this case, we can direct the user to the most straightforward usage and leave it at that. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
