Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

x/website: define the term root module in ref/mod #52227

Closed
perillo opened this issue Apr 8, 2022 · 5 comments
Closed

x/website: define the term root module in ref/mod #52227

perillo opened this issue Apr 8, 2022 · 5 comments
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Unreleased

Comments

@perillo
Copy link
Contributor

perillo commented Apr 8, 2022

The documentation for workspaces introduced a new term root module in the Go Module Reference.
The term is used in the glossary for workspace, but it is never defined.
@gopherbot gopherbot added this to the Unreleased milestone Apr 8, 2022
@perillo
Copy link
Contributor Author

perillo commented Apr 8, 2022

The article https://go.dev/blog/get-familiar-with-workspaces uses the term root module in the first paragraph, but later use the term main module in

  • use: adds a module on disk to the set of main modules in a workspace [...]

This is a bit confusing.

@mvdan
Copy link
Member

mvdan commented Apr 8, 2022

I think the docs mean to use "main module" consistently; there might have been a mistake due to the similar concept that is "root package".

@cherrymui cherrymui added NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. Documentation Issues describing a change to documentation. labels Apr 8, 2022
@cherrymui
Copy link
Member

cc @matloob @bcmills

@bcmills
Copy link
Contributor

bcmills commented Apr 12, 2022

Yes, it would be correct to use “main module” instead, since https://go.dev/ref/mod#minimal-version-selection also uses the term “main modules”:

MVS starts at the main modules (special vertices in the graph that have no version) and traverses the graph

@bcmills bcmills added help wanted NeedsFix The path to resolution is known, but the work has not been done. labels Apr 12, 2022
@gopherbot gopherbot removed the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label Apr 12, 2022
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/421895 mentions this issue: _content: consistently use main module instead of root module

@golang golang locked and limited conversation to collaborators Aug 26, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
5 participants
@mvdan @bcmills @perillo @gopherbot @cherrymui