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: Missing Retract field and ModPath struct in GoMod module reference docs #51163

Open
pkwarren opened this issue Feb 12, 2022 · 2 comments
Open
Labels
Documentation help wanted modules NeedsFix
Milestone

Comments

@pkwarren
Copy link
Contributor

@pkwarren pkwarren commented Feb 12, 2022

What version of Go are you using (go version)?

n/a

Does this issue reproduce with the latest release?

n/a

What operating system and processor architecture are you using (go env)?

n/a

What did you do?

Reviewed https://go.dev/ref/mod#go-mod-edit (source: https://github.com/golang/website/blob/master/_content/ref/mod.md#go-mod-edit-go-mod-edit)

What did you expect to see?

The description of the -json output should include the Retract []Retract field in the GoMod struct and include the ModPath struct (and the Module field should be of type ModPath).
This field and struct are present in the go help mod edit documentation.

What did you see instead?

Missing Retract field and ModPath struct.

@gopherbot gopherbot added this to the Unreleased milestone Feb 12, 2022
@dmitshur dmitshur added Documentation NeedsInvestigation labels Feb 14, 2022
@dmitshur
Copy link
Contributor

@dmitshur dmitshur commented Feb 14, 2022

Thanks for reporting. This is related to proposal #40357. CL 306334 and CL 309337 updated go help mod edit documentation, but the go.dev/ref/mod reference still needs to be updated.

CC @matloob, @bcmills.

@dmitshur dmitshur added NeedsFix and removed NeedsInvestigation labels Feb 14, 2022
@bcmills bcmills removed this from the Unreleased milestone Feb 23, 2022
@bcmills bcmills added this to the Backlog milestone Feb 23, 2022
@gopherbot
Copy link

@gopherbot gopherbot commented Mar 22, 2022

Change https://go.dev/cl/394818 mentions this issue: _content/ref: update module fields

@dmitshur dmitshur removed this from the Backlog milestone Mar 23, 2022
@dmitshur dmitshur added this to the Unreleased milestone Mar 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation help wanted modules NeedsFix
Projects
None yet
Development

No branches or pull requests

4 participants