Clarify examples in README #81
Open
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
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.
I found the examples in the README pretty confusing.
The examples as given don't actually produce the documented output, largely because the main example includes custom patterns. The example output of
--listassumes you did include custom patterns, but the example output ofresolvectl queryassumes you did not.Also it dives straight into using a prefix instead of simply the configured domain name. A naive user like me probably just wants "machine.test", so why is it talking about "test.machine.test"? Is the prefix supposed to be the same as the TLD?
So I moved the custom patterns stuff to a separate section. I removed the prefixes and instead added a small note. And I tidied up the example output to be consistent with the simplest case.