search

Open-Orange-Button / Orange-Button-Taxonomy

OpenAPI Orange Button taxonomy
https://Open-Orange-Button.github.io/Orange-Button-Taxonomy
Apache License 2.0
14 stars 19 forks source link

In OperatingReport, Clarify what each EnergyAC value represents. #210

Open kevinkirkl3y opened 1 year ago

kevinkirkl3y commented 1 year ago

We need to clarify various instances of EnergyAC values that exist within OperatingReport and what they will represent. May need to add Usage Tips.

kevinkirkl3y commented 1 year ago

This could be a shortfall of the Editor itself. Doesn't allow users to add clarification to a specific use of an element or object. The definitions and usage tips will be applied generally to all instances of an element in the Taxonomy.

kevinkirkl3y commented 1 year ago

@cwhanse It looks like you have addressed this in your Github page. Do you see any development outside the pages that needs to be done to address this issue?

cwhanse commented 1 year ago

Yes, https://github.com/Open-Orange-Button/Orange-Button-Editor/issues/29 and #215 could help. I don't think we want context-specific Documentation strings; an element should mean one and only one thing. But adding Documentation to Arrays would help, as would adding Usage Tips to the Objects.