sbp commented on issue #36: URL: https://github.com/apache/tooling-releases-client/issues/36#issuecomment-4958985408
We have [existing documentation on the check result levels](https://release-test.apache.org/docs/checks#understanding-check-results): > A note indicates that the check ran and has nothing substantial to report. Perhaps we should link to the documentation in the output, but that is only useful the first time and then redundant for every subsequent use. I think that in general we expect users to look things up in the documentation themselves. We plan a complete redesign of the user documentation of ATR soon, but this point was already documented, so I'd be interested to know what you suggest we do here, or whether the existing documentation is sufficient. The `--verbose` flag works for everything but notes. I could probably rework `check status` entirely. It doesn't currently give the processing status, as you say, and perhaps little brief notes of what each check result status means (like `note (all good, no action required)`) would be a good resolution to the documentation puzzle. In general, I was intending this command to be useful for polling from a script to see when the checks have completed. A simple boolean would be enough to satisfy that, but I figured that the extra information might be helpful somewhere. It was probably helpful to me in debugging already, though it's been a while since I worked on this. -- 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]
