/ go Public
x/pkgsite: inconsistent terminology when referring to packages makes module landing page confusing #43327
Someone must examine and confirm this is a valid issue and not a duplicate of an existing one.
Issues that involve UXD/UXR input
What is the URL of the page with the issue?
What is your user agent?
What did you do?
What did you expect to see?
I wanted to see documentation for the package at the root of the module, and specifically to find out the name that that package declares in its
The path indicated by the URL has the following properties:
github.com/mattn/go-sqlite3, and is correctly indicated by the breadcrumb nav at the top of the page.
Given those properties, I expected to see all of the following on the page, somewhere above the fold:
sqlite3is the package name but not the module path, I expected to see the string
sqlite3next to the word “package” but not next to the word “module”.
READMEand the package docs are forms of documentation, I expected to see the word “package” in the left-nav link for the package documentation.
What did you see instead?
modulebadge is displayed next to the package name instead of the module path. Since in this case the module path is not the package name, this associates the concept “module” with the wrong identifier, especially since the
READMEitself begins with (a fragment of) the actual module name.
golang.org/x/tools, where the
goplssubdirectory is a separate module. In that case, the subdirectory is pulled to the bottom of the list, instead of appearing inline with the other subdirectories. If the terminology used were “packages” and “modules” instead of simply “directories”, then that separation would make intuitive sense — however, the use of the term “directories” instead sets the expectation that the table should contain an entry for each relevant directory regardless of what kind of entity it corresponds to.
The text was updated successfully, but these errors were encountered: