Use of hotlinking of Go identifiers #337
Merged
+123
−106
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
dsnet
commented
Aug 26, 2023
| // (e.g., cmpopts.IgnoreUnexported) ignores that field or the Exporter option | ||
| // explicitly permits comparing the unexported field. | ||
| // If a struct contains unexported fields, Equal panics unless an [Ignore] option | ||
| // (e.g., [github.com/google/go-cmp/cmp/cmpopts.IgnoreUnexported]) ignores that field |
There was a problem hiding this comment.
This is extremely gross.
In my opinion, go/doc should also gather up related packages from the unit tests as well. That would be easiest and most concise way to fix reverse dependencies.
There was a problem hiding this comment.
Regardless, this is better than the status quo.
Alternatively, we can consider #136.
|
See https://godoc.digital-static.net/github.com/google/[email protected]/cmp to get a preview of what godoc looks like after this change. |
GoDoc now supports hot linking to specific Go identifiers. Use that feature to enhance the usability of cmp docs. Since cmp lacks a direct dependency on cmpopts, you are forced to use the fully-qualified import path to references identifiers in the cmpopts package. It can future improvements to the go/doc to handle this case, either by rendering the doc with short form, or by detecting the use of cmpopts from the unit tests as well (since those can break circular dependencies).
neild
approved these changes
Aug 28, 2023
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.
GoDoc now supports hot linking to specific Go identifiers. Use that feature to enhance the usability of cmp docs.
Since cmp lacks a direct dependency on cmpopts,
you are forced to use the fully-qualified import path to references identifiers in the cmpopts package.
It can future improvements to the go/doc to handle this case, either by rendering the doc with short form,
or by detecting the use of cmpopts from the unit tests as well (since those can break circular dependencies).