docs: fix Router config Godoc #9528
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
BigLep
reviewed
Jan 4, 2023
config/routing.go
Outdated
| // Reframe type allows to add other resolvers using the Reframe spec: | ||
| // https://github.com/ipfs/specs/tree/main/reframe | ||
| // In the future we will support "dht" and other Types here. | ||
| // Currenly supported Types are "http", "dht", "parallel", "sequential". |
There was a problem hiding this comment.
What is the source of truth here? Is it https://github.com/ipfs/kubo/blob/master/docs/config.md#routingrouters-type or is a constant in code? I think it would be ideal to link to the source of truth.
There was a problem hiding this comment.
the source of truth is RouterType , the type of the variable.
There was a problem hiding this comment.
I gave it another try to be more specific and avoid the same problem with outdated godoc in the future.
Signed-off-by: Antonio Navarro Perez <antnavper@gmail.com>
ajnavarro
force-pushed
the
ajnavarro/docs/fix-router-godoc
branch
from
268a785
to
986d0db
Compare
lidel
approved these changes
Jan 4, 2023
Co-authored-by: Marcin Rataj <lidel@lidel.org>
|
@ajnavarro I belive you should squash since you have a merge commit, I'm not 100% sure tho. |
galargh
pushed a commit
that referenced
this pull request
Jan 23, 2023
Co-authored-by: Marcin Rataj <lidel@lidel.org>
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.
Signed-off-by: Antonio Navarro Perez antnavper@gmail.com