Skip to content

Comments

Add docs for Script Condition wrapper#492

Merged
florian-h05 merged 6 commits intoopenhab:mainfrom
florian-h05:wrapper-docs
Oct 30, 2025
Merged

Add docs for Script Condition wrapper#492
florian-h05 merged 6 commits intoopenhab:mainfrom
florian-h05:wrapper-docs

Conversation

@florian-h05
Copy link
Contributor

Signed-off-by: Florian Hotze <dev@florianhotze.com>
Signed-off-by: Florian Hotze <dev@florianhotze.com>
Signed-off-by: Florian Hotze <dev@florianhotze.com>
@florian-h05 florian-h05 added this to the to be released milestone Oct 30, 2025
@florian-h05 florian-h05 requested a review from Copilot October 30, 2025 12:42
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR standardizes terminology and improves clarity in documentation and code comments. The changes focus on consistent hyphenation of compound adjectives and minor wording improvements for better readability.

  • Updates "UI Based" to "UI-Based" and "File Based" to "File-Based" throughout documentation
  • Improves clarity in JSDoc comments regarding dedicated context behavior
  • Minor wording adjustments for better English grammar and consistency

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
src/rules/rules.js Updates JSDoc comments to clarify dedicated context behavior and improve wording
README.md Standardizes hyphenation of compound adjectives, improves section titles, and enhances documentation clarity throughout

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

florian-h05 and others added 3 commits October 30, 2025 13:48
Signed-off-by: Florian Hotze <dev@florianhotze.com>
Signed-off-by: Florian Hotze <dev@florianhotze.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Florian Hotze <dev@florianhotze.com>
@florian-h05 florian-h05 added the documentation Improvements or additions to documentation label Oct 30, 2025
@florian-h05 florian-h05 marked this pull request as ready for review October 30, 2025 13:15
@florian-h05 florian-h05 requested a review from a team as a code owner October 30, 2025 13:15
@florian-h05 florian-h05 merged commit 1cbf37a into openhab:main Oct 30, 2025
4 of 5 checks passed
@florian-h05 florian-h05 deleted the wrapper-docs branch October 30, 2025 14:09
- .replaceMetadata(namespace, value, configuration) ⇒ `object`
- .removeMetadata(namespace) ⇒ `object|null`
- .sendCommand(value): `value` can be a string, a number, a [`time.ZonedDateTime`](#time), a [`time.Instant`](#time) or a [`Quantity`](#quantity)
- .sendCommand(value): `value` can be a string, a number, a [`time.ZonedDateTime`](#time), a, or a [`Quantity`](#quantity)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This and the next three changes do not seem right:

value can be a string, a number, a ZoneDateTime, a, or a Quantity.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reverted them in a commit to main

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants