script that checks exports for docstrings

[luke-kiernan]

Script that checks for exported types/functions without docstrings, including re-exports and partially documented methods (some instances have docstrings, some don't).

Sample usage

Details

user@system:PowerSystems.jl % julia --project=. ../SiennaTemplate.jl/scripts/check_docstrings.jl PowerSystems
=== PowerSystems (exported) ===
Types without docs (18):
  AVR
  AbstractReserve
  Contingency
  Converter
  DCSource
  Filter
  FrequencyEstimator
  InnerControl
  Machine
  Outage
  OutputCurrentLimiter
  PSS
  ... and 6 more

Functions without docs (20):
  check_ac_transmission_rate_values
  get_avr
  get_converter
  get_dc_source
  get_filter
  get_freq_estimator
  get_frequency_droop
  get_inner_control
  get_machine
  get_outer_control
  get_prime_mover
  get_pss
  ... and 8 more

Re-exported types without docs (8):
  AbstractDeterministic  (from InfrastructureSystems)
  CombinedCycleConfiguration  (from PowerSystems.CombinedCycleConfigurationModule)
  CompressionTypes  (from InfrastructureSystems.CompressionTypesModule)
  FunctionData  (from InfrastructureSystems)
  NormalizationTypes  (from InfrastructureSystems.NormalizationTypesModule)
  ProductionVariableCostCurve  (from InfrastructureSystems)
  StateTypes  (from PowerSystems.StateTypesModule)
  UnitSystem  (from InfrastructureSystems.UnitSystemModule)

Re-exported functions without docs (3):
  get_component_uuids  (from InfrastructureSystems)
  get_num_components  (from InfrastructureSystems)
  make_logging_config_file  (from InfrastructureSystems)

Documented symbols: 1878

edit: I've updated the script such that it'll ignore the dummy modules from scoped enum definitions. [I didn't bother to update the above sample output, though.]