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

[Documentation] Enum field name in SDK doesn't match the name in the spec #27947

Closed
Vyrastas opened this issue Jul 13, 2023 · 2 comments · Fixed by #29404
Closed

[Documentation] Enum field name in SDK doesn't match the name in the spec #27947

Vyrastas opened this issue Jul 13, 2023 · 2 comments · Fixed by #29404
Labels
documentation Improvements or additions to documentation needs triage Spec XML align SDK XML does not match the spec (including naming, etc)

Comments

@Vyrastas
Copy link
Contributor

Documentation issues

For the OnOff cluster, the SDK uses TogglePreviousOnOff in the OnOffStartUpOnOff enum: https://github.com/project-chip/connectedhomeip/blob/master/src/app/zap-templates/zcl/data-model/chip/onoff-cluster.xml#L24

However in the spec it uses Toggle: https://github.com/CHIP-Specifications/connectedhomeip-spec/blob/master/src/app_clusters/OnOff.adoc#ref_StartUpOnOffEnum

Not a breaking issue but worth keeping in sync. The SDK probably should be updated to match.

@andy31415 @bzbarsky-apple

Platform

No response

Anything else?

No response

@Vyrastas Vyrastas added documentation Improvements or additions to documentation needs triage labels Jul 13, 2023
@bzbarsky-apple
Copy link
Contributor

See #27092 -- the spec for this cluster could not be aligned with the XML at all until recently. At this point we need to update the XML to match the spec, but no one has had a chance to do it yet.

@bzbarsky-apple bzbarsky-apple added the Spec XML align SDK XML does not match the spec (including naming, etc) label Jul 13, 2023
@Vyrastas
Copy link
Contributor Author

See #27092 -- the spec for this cluster could not be aligned with the XML at all until recently. At this point we need to update the XML to match the spec, but no one has had a chance to do it yet.

Ah great, thanks for letting me know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation needs triage Spec XML align SDK XML does not match the spec (including naming, etc)
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants