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

Config refactor #119

Open
glensc opened this issue Apr 7, 2024 · 1 comment
Open

Config refactor #119

glensc opened this issue Apr 7, 2024 · 1 comment

Comments

@glensc
Copy link
Collaborator

glensc commented Apr 7, 2024

I find it more usable to have comments on separate line than the values.

BEFORE:

#sonarr:
#  baseUrl: "127.0.0.1:8989" # Base URL for Sonarr, including the 'http' and port and any configured urlbase. DEFAULT: "localhost:8989"
#  apikey: "YOUR-API-KEY" # API key for Sonarr, found in your Sonarr UI -> General settings
#  qualityProfile: "Your Desired Sonarr Quality Profile" # If not set, will grab the first one it finds on Sonarr
#  rootFolder: "/root/folder/location" # Root folder for Sonarr. If not set, will grab the first one it finds on Sonarr
#  bypassIgnored: false # Boolean flag to bypass tv shows that are on the Sonarr Exclusion List. DEFAULT: false
#  seasonMonitoring: all # Possible values under 'MonitorTypes' in sonarr.tv/docs/api. DEFAULT: all

AFTER:

#sonarr:
## Base URL for Sonarr, including the 'http' and port and any configured urlbase.
## DEFAULT: "localhost:8989"
#  baseUrl: "127.0.0.1:8989"

## API key for Sonarr, found in your Sonarr UI -> General settings
#  apikey: "YOUR-API-KEY"

## If not set, will grab the first one it finds on Sonarr
#  qualityProfile: "Your Desired Sonarr Quality Profile"

## Root folder for Sonarr. If not set, will grab the first one it finds on Sonarr
#  rootFolder: "/root/folder/location"

## Boolean flag to bypass tv shows that are on the Sonarr Exclusion List.
## DEFAULT: false
#  bypassIgnored: false

## Possible values under 'MonitorTypes' in sonarr.tv/docs/api.
## DEFAULT: all
#  seasonMonitoring: all

this makes more easier to diff for new changes, so you can see changes for comments and changes for values separately.

WDYT? Shall I send the PR?

@nylonee
Copy link
Owner

nylonee commented Apr 7, 2024

Oh yeah that does indeed read better I agree, feel free to raise a PR, thanks for helping with the code :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants