U-4230 Make request_timeout for monitors docs more consistent and easier to parse #133
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iatanas0v
approved these changes
Jan 16, 2025
| Description: "How long to wait before timing out the request?\n" + | ||
| " - For Server and Port monitors (types `ping`, `tcp`, `udp`, `smtp`, `pop`, `imap` and `dns`) the timeout is specified in *milliseconds*. Valid options: 500, 1000, 2000, 3000, 5000.\n" + | ||
| " - For Playwright monitors (type `playwright`), this determines the Playwright scenario timeout instead in *seconds*. Valid options: 15, 30, 45, 60.\n" + | ||
| " - For all other monitors, the timeout is specified in *seconds*. Valid options: 2, 3, 5, 10, 15, 30, 45, 60.\n", |
There was a problem hiding this comment.
The trailing newline is the actual fix, correct?
There was a problem hiding this comment.
I think the trailing new line wasn't even necessary, the issue there was I believe the missing dashes, making the list end early. I think the trailing whitespace might even get trimmed when running make gen - not sure exactly, tbh.
I added the newline just so it's easy to copy paste the lines if more cases are added in the future.
There was a problem hiding this comment.
I see. Thanks for explaining 🙏
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The original format (#131) was running into issues when our internal checks tried to parse it, not understanding the arguments below it correctly.
This was it should be easy to parse, and maybe a bit easier to read as well.
Before:
After: