Document the port timeout option in the README - #32
Merged
Conversation
I only discovered this option recently (was terminating the process manually before) and it is a little bit buried unless people bring up the --help, so briefly mentioning in the README might help surface this option.
glopesdev
self-requested a review
August 31, 2026 20:32
glopesdev
approved these changes
Aug 31, 2026
glopesdev
left a comment
glopesdev
left a comment
Contributor
There was a problem hiding this comment.
Thanks, this is a good catch. --timeout really is only visible through --help at the moment, and the README is the right place to name it.
Approving as it stands. Your change did prompt a follow-up, because it made clear that the underlying problem is the default rather than the documentation: omitting the option waits indefinitely, and the option is currently applied only to the first read. I have filed that as #35, so we will probably revisit this README line once the default exists, and make step 5 go back to the short form.
glopesdev
changed the title
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I only discovered this option recently (I was terminating the process manually before), and it is a little bit buried unless people bring up the --help, so briefly mentioning it in the README might help surface this option.