Document config template with inline comments#90
Open
arpitjain099 wants to merge 1 commit into
Open
Conversation
Document every section and key in template.config with comments explaining what each value is for and which scripts require it. Also add sensible defaults for database port (5432) and host (localhost). Addresses dbetchkal#54. Signed-off-by: arpitjain099 <arpitjain099@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Addresses #54.
The existing template.config has all the right keys but no inline docs, so you have to cross-reference the README while filling it out. This adds comments to the template explaining what each key is for and which scripts need it.
No code changes. Just documentation in the config file itself. The example configs from #74 already cover the filled-out reference case.