Write comprehensive docs for config file format and options #22
Assignees
Labels
status: archived
Archived and locked; will not be updated
type: docs
Improvements or fixes to documentation
Milestone
Comments
shaka-bot
pushed a commit
that referenced
this issue
Oct 11, 2019
The config parsing and validation system has been rewritten. The new system correctly supplies default values for each field and is self-documenting. Although the per-field docstrings are not attached to the fields by Python, they can be understood by a documentation generator. Each config structure is now represented by a class. Fields with a specific set of valid values are represented by an enum. Float fields will accept ints, and all other types are validated. Object types are constructed from sub-dictionaries, and will validate their own fields recursively. Defaults and required fields are attributes where the field is defined, making them easy to find and change. There is still more room for improvement, but adding new fields and documenting them is now very easy to do. This also flattens out the pipeline config, removing the transcoder and packager sub-keys. Tests and sample configs have been simplified to remove unnecessary fields. The test runner will now send config errors to the tests in a structured way, allowing end-to-end tests on the config parsing and validation system. Closes #11 (improve validation) Issue #22 (improve docs) Change-Id: I44d24b2f8828c09600275c1df667abaabe242404
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Currently, we only have examples in config files. There should be comprehensive docs instead. If these can't be generated from the source, then we will have to maintain them separately.
The text was updated successfully, but these errors were encountered: