docs: checking a client is one command now - #13
Merged
Merged
Conversation
The page told a reader to pass --with websockets because the checker imported an undeclared library, to run a path into a checkout rather than a command, and to start their client in another terminal and hope the socket was listening. All three are fixed upstream in plugrl-protocol. It now documents plugrl-conformance with --client, says what --client buys - the client starts after the socket is listening, and its non-zero exit is reported as its own failure - and notes that the two-terminal form still works.
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
1 participant
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.
Merge after plugrl-protocol#5, which is where
plugrl-conformancecomes from. Until that lands, this page documents a command that does not exist yet.What the page used to ask of a reader
--with websockets, because the checker imported a library the package never declared.examples/conformance_server.py- a path into a checkout, not something they can install and point at their own client.What it asks now
uv run --extra conformance plugrl-conformance --port 8000 --steps 20 --client "./my_client 127.0.0.1 8000 20"The page says what
--clientbuys rather than just showing it: the client starts after the socket is listening, so a failure to connect is about the client rather than about start-up order, and a non-zero exit from it is reported as its own failure instead of surfacing as no client ever finished.It also says the two-terminal form still works, because it does.
Both languages.
mkdocs build --strictpasses.