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

cue/load: Config.Dir docs are out of date #1734

Closed
errordeveloper opened this issue May 26, 2022 · 1 comment
Closed

cue/load: Config.Dir docs are out of date #1734

errordeveloper opened this issue May 26, 2022 · 1 comment
Assignees
@mvdan
Labels
Documentation NeedsFix

Comments

@errordeveloper
Copy link

Looks like this documentation need an update:

cue/cue/load/config.go

Lines 153 to 156 in 87408d7

// Dir is the directory in which to run the build system's query tool
// that provides information about the packages.
// If Dir is empty, the tool is run in the current directory.
Dir string

@errordeveloper errordeveloper added NeedsInvestigation Triage Requires triage/attention labels May 26, 2022
cueckoo pushed a commit that referenced this issue May 26, 2022
@mvdan
cue/load: remove old reference to a "query tool"
9e50c4a 
It looks like cue/load's API was copied from Go's go/packages,
whose Config.Dir docs are exactly the same as ours.

However, in CUE's case they are misleading.
go/packages executes `go list -json` as an external tool,
but CUE does not, instead just calling Go code to do the job.
Simplify the Dir docs to no longer make a reference to such a tool.

While here, make the third bullet point align with the first two.

Fixes #1734.

Signed-off-by: Daniel Martí <[email protected]>
Change-Id: I2c36e9e7ab1a4fe4ecb5e419bc3bd12307952ae0
@mvdan mvdan changed the title load.Config docs out of date for Dir filed cue/load: Config.Dir docs are out of date May 26, 2022
@mvdan
Copy link
Member

mvdan commented May 26, 2022

For some context: the problem here is that CUE has no "build system query tool" - this is carried over from go/packages.

@mvdan mvdan self-assigned this May 26, 2022
@mvdan mvdan added Documentation NeedsFix and removed NeedsInvestigation Triage Requires triage/attention labels May 26, 2022
@cueckoo cueckoo closed this as completed in 03ed417 Jul 1, 2022
cueckoo pushed a commit that referenced this issue Jul 1, 2022
@mvdan
cue/load: actually apply the latest doc wording per the reviews
99db97b 
Due to a Gerrit sna-fu, we approved and merged the CL with a previous
doc wording rather than the final one we agreed on.

Fixes #1734, again.

Signed-off-by: Daniel Martí <[email protected]>
Change-Id: Ibf012ca6519edee599a52316b1b5be1cea8e2166
cueckoo pushed a commit that referenced this issue Jul 1, 2022
@mvdan
cue/load: actually apply the latest doc wording per the reviews
f32ea8e 
Due to a Gerrit sna-fu, we approved and merged the CL with a previous
doc wording rather than the final one we agreed on.

Fixes #1734, again.

Signed-off-by: Daniel Martí <[email protected]>
Change-Id: Ibf012ca6519edee599a52316b1b5be1cea8e2166
Reviewed-on: https://review.gerrithub.io/c/cue-lang/cue/+/540757
Unity-Result: CUEcueckoo <[email protected]>
Reviewed-by: Paul Jolly <[email protected]>
TryBot-Result: CUEcueckoo <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mvdan mvdan

Labels
Documentation NeedsFix
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@errordeveloper @mvdan