configuration/items: use more specific item types #2195
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits).
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
The information about what happens, when the square brackets are absent, is not universally correct:
|
stefan-hoehn
requested changes
Jan 2, 2024
configuration/items.md
Outdated
| ``` | ||
|
|
||
| If no state presentation and no square brackets are given, the Item will not provide a textual presentation of its internal state (i.e. in UIs no state is shown). | ||
| If no state presentation is given, or there is no text between the square brackets, the the Item will not provide a textual presentation of its internal state (i.e. in UIs no state is shown). |
I think having all examples using as specific item types, as possible, utilizing the default UoM, is a good practice. The wording “If no state presentation and no square brackets are given…” leaves unclear what happens, if state presentation is missing, but square brackets are present. This is refined here.
dilyanpalauzov
force-pushed
the
nosquare_brackets
branch
from
25c2d56 to
69a8e90
Compare
pgfeller
pushed a commit
to pgfeller/openhab-docs
that referenced
this pull request
Jan 15, 2024
I think having all examples using as specific item types, as possible, utilizing the default UoM, is a good practice. The wording “If no state presentation and no square brackets are given…” leaves unclear what happens, if state presentation is missing, but square brackets are present. This is refined here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I think having all examples using as specific item types, as possible, utilizing the default UoM, is a good practice.
The wording “If no state presentation and no square brackets are given…” leaves unclear what happens, if state presentation is missing, but square brackets are present. This is refined here.
Alternative good wordings will be just “If no state presentation is given”, or “If no square brackets are given”.