Clean up godoc #82
Merged
Clean up godoc #82
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Closed
dnerdy
approved these changes
Sep 9, 2021
generate/generate_test.go
Outdated
| @@ -204,7 +204,7 @@ func TestGenerateWithConfig(t *testing.T) { | |||
| config := test.config | |||
| t.Run(test.name, func(t *testing.T) { | |||
| err := config.ValidateAndFillDefaults( | |||
| filepath.Join(dataDir, test.fakeConfigFilename)) | |||
| filepath.Join(dataDir, config.baseDir)) | |||
There was a problem hiding this comment.
config.baseDir is empty at this point? (Also, this value is used to set baseDir, so it seems odd to use baseDir in this context.) I think this can just be dataDir.
There was a problem hiding this comment.
Yeah this is kind of sneaky: I'm setting it in some cases above. It's probably better to just have a field in the test-case struct for that; I'll make that change.
benjaminjkraft
force-pushed
the
benkraft.init
branch
from
acd5c80 to
9de1cf4
Compare
benjaminjkraft
force-pushed
the
benkraft.docs-1
branch
from
21b983b to
06eeae3
Compare
Before open-sourcing, we want to make sure that (a) GoDoc looks reasonable, and (b) everything in the API is something we want to commit to. In this commit, I do some miscellaneous cleanup on both fronts; this does involve a few breaking changes to the programmatic API (better now than once it has users). In future commits, I'll likely move the documentation for `genqlient.yaml` and `@genqlient` to clearer places, and make `GenqlientDirective` private, such that GoDoc is really only for programmatic users. Fixes #25. Issue: #25 Test plan: make check Reviewers: marksandstrom, miguel, adam
benjaminjkraft
force-pushed
the
benkraft.docs-1
branch
from
06eeae3 to
a43f52d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary:
Before open-sourcing, we want to make sure that (a) GoDoc looks
reasonable, and (b) everything in the API is something we want to commit
to. In this commit, I do some miscellaneous cleanup on both fronts;
this does involve a few breaking changes to the programmatic API (better
now than once it has users). In future commits, I'll likely move the
documentation for
genqlient.yamland@genqlientto clearer places,and make
GenqlientDirectiveprivate, such that GoDoc is really onlyfor programmatic users.
Fixes #25.
Issue: #25
Test plan:
make check