openhab-docs icon indicating copy to clipboard operation
openhab-docs copied to clipboard

Fix wrong negation

Open felixschndr opened this issue 1 year ago • 1 comments

I am pretty sure this not is/was wrong. If not what is an item instead?

felixschndr avatar Jun 27 '24 21:06 felixschndr

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).

Built without sensitive environment variables

Name Link
Latest commit 951a03aa9145efee784d4fdddfea15ac14713cb8
Latest deploy log https://app.netlify.com/sites/openhab-docs-preview/deploys/6698098f1ccf6900088c33b8
Deploy Preview https://deploy-preview-2323--openhab-docs-preview.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Jun 27 '24 21:06 netlify[bot]

Thanks for the contribution, but I believe the original text is not incorrect. It explains itself in the next sentence clause. I agree though that the whole sentence is a bit nebulous but I guess it's kind of an introduction to what an Item is.

jimtng avatar Jul 15 '24 00:07 jimtng

I kind of understand where Felix is coming from.

An Item does not simply store information that is set by software (e.g., OFF, 3.141 or "No Error"); the information stored by an Item may also be set by actions that take place in your home.

How about phrasing it like that?

An Item does not simply store information that is set by software (e.g., OFF, 3.141 or "No Error") but rather information that is set by actions that take place in your home.

stefan-hoehn avatar Jul 16 '24 18:07 stefan-hoehn

How about this? (Just remove the confusing part)

An Item does store information that is set by actions that take place in your home (e.g., OFF, 3.141 or No Error).

felixschndr avatar Jul 17 '24 07:07 felixschndr

My suggestion would be to simply delete lines 15-18 completely. They don't give you information that isn't already explained further down. All they seem to do is add "noise" and confusion in your mind as you read through, especially if you are coming from a "blank canvas" not knowing anything about Items.

The actual knowledge about items will be built up by reading through the subsequent paragraphs which do provide actual and practical information about what Items are and what they do.

jimtng avatar Jul 17 '24 07:07 jimtng

My suggestion would be to simply delete lines 15-18 completely. They don't give you information that isn't already explained further down. All they seem to do is add "noise" and confusion in your mind as you read through, especially if you are coming from a "blank canvas" not knowing anything about Items.

The actual knowledge about items will be built up by reading through the subsequent paragraphs which do provide actual and practical information about what Items are and what they do.

I agree 👍🏻

felixschndr avatar Jul 17 '24 07:07 felixschndr

Me too, do you change the PR accordingly?

stefan-hoehn avatar Jul 17 '24 17:07 stefan-hoehn

Done

felixschndr avatar Jul 17 '24 18:07 felixschndr