docs: update example usage #219
Merged
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
Signed-off-by: Dwi Siswanto <[email protected]>
dwisiswant0
commented
Aug 20, 2024
| // it requires a list of resolvers | ||
| resolvers := []string{"8.8.8.8:53", "8.8.4.4:53"} | ||
| // It requires a list of resolvers. | ||
| // Valid protocols are "udp", "tcp", "doh", "dot". Default are "udp". |
There was a problem hiding this comment.
I think this should also be documented somewhere else, like making parseResolver an exported function.
There was a problem hiding this comment.
+1 - Just checked the readme and we are missing this info. Marking the PR as changes requested
There was a problem hiding this comment.
You are reviewing the README tho, @Mzack9999. 😃
Are you suggesting creating a separate section? I'd rather have this documented within the code so it can be served by godoc. Thoughts?
There was a problem hiding this comment.
lol yeah, I think it would be probably useful here, it's quite an important functionality
Something like:
- supports resolvers ... (tcp, udp, doh, etc)
Mzack9999
requested changes
Sep 2, 2024
Signed-off-by: Dwi Siswanto <[email protected]>
Mzack9999
approved these changes
Sep 3, 2024
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.
No description provided.