Improved the Scale Transformation article. #4443
Conversation
Main discussion took part in: openhab/openhab-docs#486 Signed-off-by: Jerome Luckenbach <github@luckenba.ch> (github: @Confectrician)
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
There was a problem hiding this comment.
Really great improvement, thanks!!! 👍
I have to admit that without your changes I didn't really get what this transformation is about.
I'm even thinking if it would make sense to mention the term "discretization" somewhere, although I'm not exactly sure whether it mathematically is fully correct or not.
One additional thought: Do you think it would make sense to explain the "inclusive" and "exclusive" bracket notations a little (for the less savvy users)? I'm not sure if that becomes clear if somebody never heard of that...
| @@ -1,16 +1,51 @@ | |||
| # Scale Transformation Service | |||
|
|
|||
| Transform the input by matching it between limits of ranges in a scale file. The input string must be in numerical format. | |||
| Transform a given input by matching it between limits of ranges. | |||
There was a problem hiding this comment.
I know, you just broke the lines here, but would you agree that "Transform a given input by matching it to ranges" is less confusing?
There was a problem hiding this comment.
Totally agree.
Wdyt about:
"Transform a given input by matching it to specific ranges."
or
"Transform a given input by matching it to specified ranges."
Just to make directly clear, that there are no fixed ranges somewhere in esh that are used for that.
|
|
||
| Each value the item receives, will be categorized to one of the five given ranges. | ||
| Values **lower than or equal to 3** are caught with `[..3]=1`. | ||
| Greater values are catched in ranges with 2 values as criteria. |
There was a problem hiding this comment.
are catched -> "are caught" (or maybe rather "are matched")
There was a problem hiding this comment.
I think "matched" it will be, when I compare the options.
That sounds/reads the best. (My opinion)
| Each value the item receives, will be categorized to one of the five given ranges. | ||
| Values **lower than or equal to 3** are caught with `[..3]=1`. | ||
| Greater values are catched in ranges with 2 values as criteria. | ||
| The only condition here is that the received value has to be lower than or equal to `100` in our example, since we haven't defined other cases yet. |
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
That would be something for an opener sentence.
Good point. I have thought about that too already. Wdyt? |
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
Sure, there is no pressure to do it here in this PR. This is a huge improvement as it is now! [For the record: The automatic IP validation fails because of the edit directly within Github. I manually verified that your ECA is valid, so that's fine.] |
|
Hm not sure, but a first try: "The Scale Transformation Service is a an easy to handle tool, that can help you with the discretization of number inputs." second sentence would then be changed to something like this: |
|
Yes, for me this totally makes sense. I like it! |
… sentence. Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
|
Here we go. Update is done. One off topic thing for my understanding:
Did this fail due to the missing sign off within the PR message? |
|
Thanks!
No, they were fine (but yes, a missing sign-off line also makes it fail). The problem is that github's web editor created commits with itself as the committer and not you. So the only way around it would be not using the web editor. However, doing the lookup manually really is nothing more than two clicks and a c'n'p of your email address. I'm very happy to do that manually if that helps setting the barrier as low as possible for improving our documentation. |
This PR is moved from openHAB documentation.
Main discussion took part in:
openhab/openhab-docs#486
We already discussed there about a more handy example in the future,
but there are no details yet, so i wanted to finish this reworking on the current state.
For the record:
Related: #4439
Closes openhab/openhab-docs#486
Closes openhab/openhab-docs#484
Since this is my first PR on a eclipse repo, feel free to comment if there is something missing.
I have done all the steps from the contribution guidelines.
(Eclipse Account, GitHub Settings in there, Contributor Agreement)
Most things should be ok this way.
Signed-off-by: Jerome Luckenbach github@luckenba.ch (github: @Confectrician)