Version 1.0 documentation

[mmcauliffe]

Check and make sure every part of the Polyglot API is documented. For each instance, it should be in the user documentation if the function/class is forward facing and intended to be called by users and in the API section with full docstrings for all functions.

polyglotdb

• [ ] acoustics
  • [x] formants
    • [x] base.py
    • [x] helper.py
    • [x] refined.py
  • [ ] pitch
    • [ ] base.py
    • [x] refined.py
  • [x] vot
    • [x] base.py
  • [x] classes.py
  • [x] intensity.py
  • [ ] io.py
  • [x] segments.py
  • [x] utils.py
• [x] client
• [ ] corpus
  • [ ] annotated.py
  • [x] audio.py
  • [x] base.py
  • [x] context.py
  • [ ] importable.py
  • [x] lexical.py
  • [x] pause.py
  • [x] phonological.py
  • [x] spoken.py
  • [x] structured.py
  • [x] summarized.py
  • [x] syllabic.py
  • [ ] utterance.py
• [x] databases
  • [x] config.py
• [ ] io
  • [x] enrichment
    • [x] features.py
    • [x] helper.py
    • [x] lexical.py
    • [x] spoken.py
  • [x] exporters
    • [x] base.py
    • [x] csv.py
    • [x] textgrid.py
  • [ ] importer
    • [ ] from_csv.py
    • [ ] to_csv.py
  • [x] inspect
    • [x] buckeye.py
    • [x] fave.py
    • [x] labbcat.py
    • [x] maus.py
    • [x] mfa.py
    • [x] partitur.py
    • [x] textgrid.py
    • [x] timit.py
  • [x] parsers
    • [x] aligner.py
    • [x] base.py
    • [x] buckeye.py
    • [x] fave.py
    • [x] labbcat.py
    • [x] maus.py
    • [x] mfa.py
    • [x] partitur.py
    • [x] textgrid.py
    • [x] timit.py
  • [ ] types
    • [ ] base.py
    • [ ] content.py
    • [ ] form.py
    • [ ] parsing.py
    • [ ] standardized.py
  • [x] discoursedata.py
  • [x] helper.py
• [ ] query
  • [ ] annotations
    • [ ] attributes
      • [ ] acoustic.py
      • [ ] aggregate.py
      • [ ] base.py
      • [ ] discourse.py
      • [ ] hierarchical.py
      • [ ] path.py
      • [ ] pause.py
      • [ ] precedence.py
      • [ ] speaker.py
      • [ ] subannotation.py
    • [ ] elements.py
    • [ ] models.py
    • [ ] query.py
    • [ ] results.py
  • [ ] base
    • [ ] attributes.py
    • [ ] complex.py
    • [ ] cypher.py
    • [ ] elements.py
    • [ ] func.py
    • [ ] helper.py
    • [ ] query.py
    • [ ] results.py
  • [ ] discourse
    • [ ] attributes.py
    • [x] query.py
  • [ ] lexicon
    • [ ] attributes.py
    • [x] query.py
  • [x] metadata
    • [x] query.py
  • [ ] speaker
    • [ ] attributes.py
    • [x] query.py
• [x] syllabification
  • [x] main.py
  • [x] maxonset.py
  • [x] probabilistic.py
• [x] config.py
• [x] exceptions.py
• [x] structure.py
• [x] utils.py

Related issues: #142, #143 , #144

[msonderegger]

Note from the to-do list: MG should be able to do a lot of the docstrings.