Clarify exports

[jml]

Filing as separate bug to avoid scope creep in #99.

Goal is that the public modules should be self-complete. Everything that appears in a type signature in the public modules should be exported from one of the public modules.

This means that users should not have to import internal modules to write type signatures, nor run into things like #165.

Probably don't work on this until #99 is done, as that will make the distinction between internal & external much more clear.

Here's stuff in our public modules that appear in type signatures etc. but are not exported anywhere:

• GraphQL.Value
  • [ ] UnresolvedVariableScalar
• GraphQL.API
  • [ ] RunFields
  • [ ] RunFieldsType
  • [ ] HasInterfaceDefinitions
  • [ ] HasFieldDefinitions
  • [ ] RunUnion
  • [ ] HasUnionTypeObjectTypeDefinitions
  • [ ] GenericEnumValues
  • [ ] GenericAnnotatedInputType
  • [ ] HasArgumentDefinition
  • [ ] HasFieldDefinition
  • [ ] HasInterfaceDefinition
• GraphQL.Resolver
  • [ ] RunUnion
  • [ ] RunFields
  • [ ] RunFieldsType
  • [ ] ~
  • [ ] TypeIndex
  • [ ] DynamicUnionValue
  • [ ] runFields

In addition, here's what's in our public modules that must be imported from internal modules:

• GraphQL.Value
  • [ ] Value
  • [ ] OrderedMap
• GraphQL.API
  • [ ] SelectionSetByType
  • [ ] AnnotatedType
  • [ ] GType
  • [ ] ObjectTypeDefinition
  • [ ] InputType
  • [ ] ArgumentDefinition
  • [ ] FieldDefinition
  • [ ] InterfaceTypeDefinition
• GraphQL.Resolver
  • [ ] ValidationErrors
  • [ ] SelectionSetByType
• GraphQL
  • [ ] Errors
  • [ ] QueryDocument
  • [ ] VariableValue
  • [ ] Variable
  • [ ] substituteVariables (I think this is for source code linking?)

Here's stuff in our internal modules that's in type sigs but not exported:

• GraphQL.Internal.Schema
  • [ ] ScalarTypeDefinition
  • [ ] TypeExtensionDefinition
  • [ ] DefaultValue
• GraphQL.Value.FromValue
  • [ ] GenericFromValue
• GraphQL.Internal.Output
  • [ ] Location
• GraphQL.Internal.Validation
  • [ ] Operations
  • [ ] Field'
  • [ ] Validator
  • [ ] Query
  • [ ] Mutation
  • [ ] FragmentDefinition
  • [ ] mapErrors
• GraphQL.API.Enum
  • [ ] GenericEnumValues

(This is from mucking around with Haddock. I wish there were a better way.)

[theobat]

Can I help with this ? Has anything been done in the list already ?

[jml]

Please go ahead!

I might have done some things on the list: I've forgotten.

The goal is that if something appears on a non-internal module in haddock, then clicking the link should stay non-internal.

Likewise, if something appears in a type signature, it should be exported.

I've found the easiest way to analyze this is to run haddock and look at the output manually. Really there should be a linter tool for it.