Skip to content

x/tools/go/packages: documentation on overlays is incomplete #67601

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
Closed
dominikh opened this issue May 23, 2024 · 3 comments
Closed

x/tools/go/packages: documentation on overlays is incomplete #67601

dominikh opened this issue May 23, 2024 · 3 comments
Assignees
@adonovan
Labels
Documentation Issues describing a change to documentation. NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. Tools This label describes issues relating to any tools in the x/tools repository.
Milestone
Unreleased

Comments

@dominikh
Copy link
Member

The documentation of Config.Overlay says

Overlays provide incomplete support for when a given file doesn't
already exist on disk. See the package doc above for more details.

but the package documentation doesn't talk about overlays at all.
@gopherbot gopherbot added the Tools This label describes issues relating to any tools in the x/tools repository. label May 23, 2024
@gopherbot gopherbot added this to the Unreleased milestone May 23, 2024
@gopherbot gopherbot added the Documentation Issues describing a change to documentation. label May 23, 2024
@dominikh
Copy link
Member Author

Apparently this is part of doc.go, but only as an internal comment, not part of the package documentation. I'm not sure it's relevant anymore, either.

@cagedmantis cagedmantis added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label May 23, 2024
@cagedmantis
Copy link
Contributor

cc @matloob

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/588141 mentions this issue: go/packages: document fields that are part of JSON schema

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@adonovan adonovan

Labels
Documentation Issues describing a change to documentation. NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. Tools This label describes issues relating to any tools in the x/tools repository.
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
4 participants
@dominikh @cagedmantis @adonovan @gopherbot