Documentation Improvements for Spark.Dsl.Section

[erikareads]

Proposal

This issues is to keep track of improvement ideas for the documentation for Spark.Dsl.Section.

Questions

• What field are required for an Section? Do we want to specially notate that in some way?

Work to be done

• Write 1-2 paragraph description of what Entities are for, and how they are used.
• Add basic example of an Entity struct in moduledoc
• Add custom types for each Section struct field. Move detailed explanation of fields and specific examples to @typedocs on these types.
  • add typedoc - auto_set_fields
  • add typedoc - deprecations
  • add typedoc - describe
  • add typedoc - docs
  • add typedoc - entities
  • add typedoc - examples
  • add typedoc - imports
  • add typedoc - links
  • add typedoc - modules
  • add typedoc - name
  • add typedoc - no_depend_modules
  • add typedoc - patchable?
  • add typedoc - schema
  • add typedoc - sections
  • add typedoc - snippet
  • add typedoc - top_level?