Clean up API #25
Comments
@StevenACoffman I'm interested if you know how other code-generation libraries in Go handle this. It seems very awkward to me because it's going to be hard to guarantee that existing generated code is rarely updated -- even the smallest bugfix may need to change it! But if users want to check in the generated code, and make sure |
|
The compat issue is now discussed more at #63, but I think for v0 the path is clear enough, so this is just to make sure we do a pass over godoc before launching. |
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
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
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
## 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.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 Author: benjaminjkraft Reviewers: dnerdy, benjaminjkraft, jvoll, aberkan, MiguelCastillo, mahtabsabet Required Reviewers: Approved By: dnerdy, jvoll Checks: ✅ Test (1.17), ✅ Test (1.16), ✅ Test (1.15), ✅ Test (1.14), ✅ Lint, ✅ Test (1.17), ✅ Test (1.16), ✅ Test (1.15), ✅ Test (1.14), ✅ Lint Pull Request URL: #82
This is just to make sure there's nothing in godoc that we don't want to commit to. Although of course in v0 we don't totally have to.
At some point we will also need to decide if we consider a change to generated code to be breaking; it is only if you re-run your generator but obviously you want to be able to do that. (What if it's a non-functional change? That's only breaking if you expect your generator to be deterministic, which you might also reasonably want.)
See also #19.
The text was updated successfully, but these errors were encountered: