Update README to make behavior of idReplacement more clear #516
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
Updated README to make the behavior of idReplacement more clear
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.
As a user of Autocannon, it took far too long to figure out why the idReplacement system was not working. Ultimately it was the source code which revealed that replacement target was, in its entirety,
[<id>]. It's a bit unusual to have a two character wrapper where both characters are different, so we interpreted the square braces as a code container in the same way backticks might be used. It appears in other parts of the README, you've used backticks to better represent that the entire string is the target. So I've updated the command line example with this as well.