Clean up godoc (#82)
## 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: https://github.com/Khan/genqlient/issues/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: https://github.com/Khan/genqlient/pull/82
This commit is contained in:
@@ -329,11 +329,12 @@ func (g *generator) addOperation(op *ast.OperationDefinition) error {
|
||||
return nil
|
||||
}
|
||||
|
||||
// Generate returns a map from absolute-path filename to generated content.
|
||||
// Generate is the main programmatic entrypoint to genqlient, and generates and
|
||||
// returns Go source code based on the given configuration.
|
||||
//
|
||||
// This is the main entrypoint to the code-generation process for callers who
|
||||
// wish to manage the config-reading (ReadAndValidateConfig) and file-writing
|
||||
// on their own. (Those are wired in by Main.)
|
||||
// See Config for more on creating a configuration. The return value is a map
|
||||
// from filename to the generated file-content (e.g. Go source). Callers who
|
||||
// don't want to manage reading and writing the files should call Main.
|
||||
func Generate(config *Config) (map[string][]byte, error) {
|
||||
// Step 1: Read in the schema and operations from the files defined by the
|
||||
// config (and validate the operations against the schema). This is all
|
||||
@@ -343,7 +344,7 @@ func Generate(config *Config) (map[string][]byte, error) {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
document, err := getAndValidateQueries(config.baseDir(), config.Operations, schema)
|
||||
document, err := getAndValidateQueries(config.baseDir, config.Operations, schema)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user