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/_content/doc/modules: invalid require directive example #70747

Closed
Eynorey opened this issue Dec 10, 2024 · 3 comments
Closed

x/website/_content/doc/modules: invalid require directive example #70747

Eynorey opened this issue Dec 10, 2024 · 3 comments
Labels
Documentation Issues describing a change to documentation. NeedsFix The path to resolution is known, but the work has not been done. website
Milestone

Comments

@Eynorey
Copy link

Eynorey commented Dec 10, 2024

What is the URL of the page with the issue?

https://go.dev/doc/modules/managing-source#multiple-module-source

What is your user agent?

n/a

Screenshot

image

What did you do?

n/a

What did you expect to see?

The doc describes the setup of a mono-repository with multiple modules that each have their own version.

In the example it says that module module1 can be versioned by pushing the version tag module1/v1.2.3, but then incorrectly states the the require directive for that module and that version needs to be example.com/mymodules/module1 module1/v1.2.3, whereas instead it needs to be example.com/mymodules/module1 v1.2.3.

+ Module path as given in a user’s require directive: example.com/mymodules/module1 v1.2.3

What did you see instead?

- Module path as given in a user’s require directive: example.com/mymodules/module1 module1/v1.2.3
@gopherbot gopherbot added this to the Unreleased milestone Dec 10, 2024
@seankhliao seankhliao added Documentation Issues describing a change to documentation. NeedsFix The path to resolution is known, but the work has not been done. labels Dec 10, 2024
@seankhliao seankhliao changed the title x/website: Wrong example of module require directive for tags from mono-repos x/website/_content/doc/modules: invalid require directive example Dec 10, 2024
@gopherbot
Copy link
Contributor

Change https://go.dev/cl/635280 mentions this issue: _content/doc/modules: fix incorrect require directive if modules doc

@findleyr
Copy link
Member

Thanks for reporting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues describing a change to documentation. NeedsFix The path to resolution is known, but the work has not been done. website
Projects
None yet
Development

No branches or pull requests

5 participants