Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added comments to each section and key #100

Conversation

asgibson
Copy link
Contributor

No description provided.

@asgibson asgibson added documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested convention Repository coding and documentation standards labels Dec 12, 2023
@asgibson asgibson self-assigned this Dec 12, 2023
@asgibson asgibson linked an issue Dec 12, 2023 that may be closed by this pull request
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (822cd97) 100.00% compared to head (1c54fe5) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #100   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           25        25           
  Lines          938       938           
  Branches       129       129           
=========================================
  Hits           938       938           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@the-other-james the-other-james left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a good time to update some of the terminology we use. I think we also need to figure out how to deal with keys that are required but not always used (like TelemetryFile)

onair/config/default_config.ini Show resolved Hide resolved
onair/config/default_config.ini Show resolved Hide resolved
Copy link
Contributor

@the-other-james the-other-james left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Thanks for making #101

@asgibson asgibson merged commit c2e1d42 into main Jan 4, 2024
2 checks passed
@asgibson asgibson deleted the 99-comment-default_configini-to-explain-what-the-sections-and-keys-are branch January 4, 2024 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
convention Repository coding and documentation standards documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Comment default_config.ini to explain what the sections and keys are
3 participants