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.

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

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

Open
perillo opened this issue Apr 8, 2022 · 4 comments
Open

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

perillo opened this issue Apr 8, 2022 · 4 comments
Labels
Documentation help wanted NeedsFix
Milestone

Comments

@perillo
Copy link
Contributor

@perillo 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 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 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 Documentation labels Apr 8, 2022
@cherrymui
Copy link
Contributor

@cherrymui cherrymui commented Apr 8, 2022

@bcmills
Copy link
Member

@bcmills 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 labels Apr 12, 2022
@gopherbot gopherbot removed the NeedsInvestigation label Apr 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation help wanted NeedsFix
Projects
None yet
Development

No branches or pull requests

5 participants