rudders / homebridge-http

HTTP Plugin for Homebridge
Apache License 2.0
178 stars 110 forks source link

Updated JSON formatting for sample-config.json #62

Closed jbree closed 7 years ago

jbree commented 7 years ago

Mix of tabs and spaces was confusing, especially when reading on github.

NovaGL commented 7 years ago

This is debatable. The reason it's spaced like that is to separate the sections.

Eg the switch section and the service section, if it is not tabbed it's hard to see. Happy to have a look at changing it but still would like it to look similar to before

jbree commented 7 years ago

I understand what you're saying. My personal experience was that I looked at it and had to look pretty closely to understand what was going on. Rather than helping me understand the fields, it made me think harder to figure out the structure.

I would argue that most people who read JSON expect the tab structure to reflect the object structure. But I wouldn't argue it passionately, because it's just not that important.

Also, I had never tried making a pull request before, so I figured I'd try it with something fairly innocuous. Either way, thanks for your consideration.

NovaGL commented 7 years ago

Thanks for your explanation and it makes sense. I am glad you didn't take offence to my question as based on your theory I would think I would be in the minority.