HAP-NodeJS icon indicating copy to clipboard operation
HAP-NodeJS copied to clipboard

Fix naming for Characteristic.ProgramMode

Open n0rt0nthec4t opened this issue 2 years ago • 4 comments

removes extra '' on end of value Characteristic.ProgramMode.PROGRAM_SCHEDULED_MANUAL_MODE

:recycle: Current situation

Seems extra '_' on end of define was unintentional

:bulb: Proposed solution

Changes naming Characteristic.ProgramMode.PROGRAM_SCHEDULED_MANUAL_MODE_ to Characteristic.ProgramMode.PROGRAM_SCHEDULED_MANUAL_MODE

:gear: Release Notes

This maybe a breaking change as removes define for "PROGRAM_SCHEDULED_MANUAL_MODE_". Developers will need to updated any used of Characteristic.ProgramMode.PROGRAM_SCHEDULED_MANUAL_MODE_ to Characteristic.ProgramMode.PROGRAM_SCHEDULED_MANUAL_MODE

n0rt0nthec4t avatar Jun 29 '23 23:06 n0rt0nthec4t

Pull Request Test Coverage Report for Build 5433048924

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.003%) to 65.017%

Totals Coverage Status
Change from base Build 4845506880: 0.003%
Covered Lines: 7397
Relevant Lines: 10595

💛 - Coveralls

coveralls avatar Jun 29 '23 23:06 coveralls

I'm not sure if this change is worth deliberately breaking plugins. I would either just leave it as is, or introduce the corrected PROGRAM_SCHEDULED_MANUAL_MODE while deprecating the old PROGRAM_SCHEDULED_MANUAL_MODE_ and have a grace period before completely removing it.

bauer-andreas avatar Jun 30 '23 16:06 bauer-andreas

@Supereg fair call.. I think we should have it fixed from a naming consistency view.. I’ll update the commit with the old and new and mark the old as deprecated

n0rt0nthec4t avatar Jun 30 '23 21:06 n0rt0nthec4t

Probably not in scope, but I noticed some warning is those example Accessories related to special chars in names. Probably related to recent PR in beta?

Shaquu avatar Jun 25 '24 09:06 Shaquu

Probably not in scope, but I noticed some warning is those example Accessories related to special chars in names. Probably related to recent PR in beta?

yes but should be resolved.

donavanbecker avatar Jul 09 '24 02:07 donavanbecker