https://go.dev/doc/comment says:
*When referring to other packages, “pkg” can be either a full import path or the assumed package name of an existing import. The assumed package name is either the identifier in a renamed import or else the name assumed by goimports <https://pkg.go.dev/golang.org/x/tools/internal/imports#ImportPathToAssumedName>. (Goimports inserts renamings when that assumption is not correct, so this rule should work for essentially all Go code.) For example, if the current package imports encoding/json, then “[json.Decoder]” can be written in place of “[encoding/json.Decoder]” to link to the docs for encoding/json’s Decoder. If different source files in a package import different packages using the same name, then the shorthand is ambiguous and cannot be used.* Now I'm facing in my project github.com/thediveo/whalewatcher the situation where in the top-package documentation I would like to reference a sub package, github.com/thediveo/whalewatcher/watcher in particular. Unfortunately, I'm unable to import the watcher package from the top-level whalewatcher package due to an import cycle. In fact, normal usage of the whalewatcher and watcher packages by module users never results in an import cycle. Is there some lesser known trick to avoid showing overly long import paths in package references in doc comments in case the respective package cannot be imported? -- You received this message because you are subscribed to the Google Groups "golang-nuts" group. To unsubscribe from this group and stop receiving emails from it, send an email to golang-nuts+unsubscr...@googlegroups.com. To view this discussion on the web visit https://groups.google.com/d/msgid/golang-nuts/899ab9df-af7a-4b73-a58c-2de607192450n%40googlegroups.com.
