Skip to content
This repository has been archived by the owner on May 17, 2021. It is now read-only.

[CalDAV-Command] Readability enhancements for README #5789

Merged
merged 3 commits into from
Dec 12, 2019
Merged

[CalDAV-Command] Readability enhancements for README #5789

merged 3 commits into from
Dec 12, 2019

Conversation

semperor
Copy link
Contributor

changed pre to ``` for better readability on openhab.org

@semperor
Update README.md
1d5a80a 
changed pre to ``` for better readability on openhab.org
@semperor semperor changed the title Update README.md [caldav-command] Update README.md Feb 11, 2019
9037568
9037568 suggested changes Feb 12, 2019
View reviewed changes
Copy link
Contributor

@9037568 9037568 left a comment

Choose a reason for hiding this comment

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

Just a few tweaks, if you please.

bundles/binding/org.openhab.binding.caldav-command/README.md
@@ -59,7 +61,9 @@ openhab.cfg

## Default item
Since 1.9.0, the CalDAV Command binding also supports a default item which may optionally be added to openhab.cfg:
<pre>caldavCommand:defaultItemOnBegin=&lt;item&gt;</pre>
```
caldavCommand:defaultItemOnBegin=&lt;item&gt;
Copy link
Contributor

Choose a reason for hiding this comment

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

This doesn't render correctly this way.

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 am not very experienced with github. What exactly do you mean?

bundles/binding/org.openhab.binding.caldav-command/README.md Outdated
#caldavio:<calendar-id>:password=
#caldavio:<calendar-id>:reloadInterval=<minutes>
#caldavio:<calendar-id>:preloadTime=<minutes>
#caldavio:timeZone=<e. g. Europe/Berlin>
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's remove the <e. g. Europe/Berlin> since it's repeated many times below

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is apparently just a copy from the configuration file. I think we should just leave it in there.

Copy link
Contributor

Choose a reason for hiding this comment

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

Good point. In that case we should remove the entire block.

bundles/binding/org.openhab.binding.caldav-command/README.md Outdated

# Additionally needed binding: org.openhab.binding.caldav-command-<version>.jar
# used to execute commands by a triggered event
# multiple calendars (calerdar-id) can be seperated by commas
Copy link
Contributor

Choose a reason for hiding this comment

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

"separated"

@9037568 9037568 changed the title [caldav-command] Update README.md [caldav-command] Readability enhancements for README Feb 12, 2019
@9037568 9037568 changed the title [caldav-command] Readability enhancements for README [CalDAV-Command] Readability enhancements for README Feb 12, 2019
@semperor
Update README.md
83720c9 
1. Added additional lines above/below the ```
2. Removed "## (zarafa?)"
3. Removed example block as discussed
4. Removed "Müllkalender" to make the example clearer. That calendar configuration was identical to the command calendar.
@semperor
Update README.md
b6a067d 
seperated --> separated
kaikreuzer
kaikreuzer reviewed Dec 12, 2019
View reviewed changes
bundles/binding/org.openhab.binding.caldav-command/README.md
<pre>caldavCommand:defaultItemOnBegin=&lt;item&gt;</pre>

```
caldavCommand:defaultItemOnBegin=&lt;item&gt;
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
caldavCommand:defaultItemOnBegin=&lt;item&gt;
caldavCommand:defaultItemOnBegin=<item>

@kaikreuzer kaikreuzer merged commit 54df629 into openhab:master Dec 12, 2019
Efus10n added a commit to Efus10n/openhab1-addons that referenced this pull request Jan 1, 2020
@Efus10n @kaikreuzer
@DaHoC @marekhalmo @bitDealer @dirkbe @sthorsen @cweitkamp @wborn @mueller-ma @slawekjaranowski @CSchlipp @ahessling @Arut42 @amosk @paulianttila @paphko @peternewman @oktett-8 @msimat @semperor @on4tux @9037568 @aurelio1 @bgilmer77 @dev-mansonthomas
update (#1)
40b0cd5 
* moved legacy bindings to the correct feature (openhab#5893)

Signed-off-by: Kai Kreuzer <[email protected]>

* removed Sen.se persistence service (openhab#5850)

Signed-off-by: Kai Kreuzer <[email protected]>

* removed sense persistence service from distro pom (openhab#5894)

Signed-off-by: Kai Kreuzer <[email protected]>

* Update README.md (openhab#5898)

Add FritzBox TR064 Item configuration for events for active calls, present in the source code of the binding since 20.12.2015

Signed-off-by: Jan Hendriks <[email protected]>

* Fix Serial binding where serial commands in rapid succession were not recognized (openhab#5891)

Signed-off-by: Marek Halmo <[email protected]>

* updated product links (openhab#5901)

Signed-off-by: Kai Kreuzer <[email protected]>

* Typo lead to confusing instructions (openhab#5896)

The address in the first example is 0x21, but the explenation under it statet the address as 0x20. The second example shows the right way

* Update README.md adding FB 6490 (openhab#5900)

Added Fritz Box 6490 Cable (v7.02) as working and supported model.

Signed-off-by: dirkbe <[email protected]>

* - Fixing a minor TYPO (openhab#5878)

- Adding that no `things` file configuration required

Signed-off-by: Soren Thorsen <[email protected]>

* Update org.apache.http dependencies (openhab#5887)

Signed-off-by: Christoph Weitkamp <[email protected]>

* Fix empty reactor summary on newer Maven versions (openhab#5885)

On newer Maven versions the reactor summary also contains the project name and version so the regexp needs to be adjusted for this.
Also make sure grep treats binary data as text (-aE switch) so the pipe doesn't choke on this.

Signed-off-by: Wouter Born <[email protected]>

* Fixed POM XML Shema Definition path (openhab#5903)

Signed-off-by: Christoph Weitkamp <[email protected]>

* moved networkupstools to legacy addons (openhab#5904)

Signed-off-by: Kai Kreuzer <[email protected]>

* [fritzboxtr0641] Improve docs (openhab#5908)

* Translate log message
* Wifi => Wi-Fi, see https://en.wikipedia.org/wiki/Wi-Fi
* Use capital letter after bullet point

Signed-off-by: mueller-ma <[email protected]>

* [KNX.Test] workaround for timezone in KNXCoreTypeMapperTest (openhab#5912)

Signed-off-by: Slawomir Jaranowski <[email protected]>

* Added utime (openhab#5910)

Signed-off-by: Christoph Weitkamp <[email protected]>

* Fixed restriction on special characters in URLs (openhab#5868)

Escaping special characters in URLs allows usage of calendar-ids with special characters, e.g. private-home --> private%2Dhome

Signed-off-by: CSchlipp <[email protected]>

* Novelan heatpump: Add output signals and additional state variables as items, add missing heatpump states (openhab#5883)

Signed-off-by: Andre Heßling <[email protected]>

* little Mistake (openhab#5909)

* [fatekplc] Serial port support (openhab#5877)

Signed-off-by: Slawomir Jaranowski <[email protected]>

* Update README.md with improved config info. (openhab#5841)

* fixed typo

* [swegon] Added throttle support (openhab#5685)

Signed-off-by: Pauli Anttila <[email protected]>

* [oem] throttle support (openhab#5684)

Signed-off-by: Pauli Anttila <[email protected]>

* Anel binding: mask pwd in log entries; issue openhab#5716 (openhab#5828)

* Use stock OLA from OS by default (openhab#5696)

* [GPIO] Fixes debounce Item state out of sync (openhab#5729) (openhab#5730)

* Fixes GPIO Binding Item state out of sync even with debounce set.

Fixes openhab#5729

Signed-off-by: Ingo Schuck <[email protected]> (github: oktett-8)

* fixed compilation error (openhab#5919)

Signed-off-by: Kai Kreuzer <[email protected]>

* Update README.md (openhab#5920)

Tested myself on FB 7580

* [Davis] Formatting changes for README (openhab#5794)

* [Daikin] Formatting changes for README (openhab#5793)

* Update README.md

changed pre to ``` for better readability on openhab.org

* Update README.md

Added empty line above code fences

* [Diyonxbee] Formatting changes for README (openhab#5796)

* [CalDAV-Command] Readability enhancements for README (openhab#5789)

* Update README.md

* [Cups] Update README with better sendCommand alternative (openhab#5792)

* Fixed minor typo (openhab#5780)

* fixed typo

* [CalDAV-Personal] Minor cleanup for README (openhab#5790)

* Update README.md

* [SNMP] Update README.md for the version property (openhab#5779)

* Update README.me

according to openhab#2426, the binding supports at least also version v2c. I tested it to make a COUNTER64 OID work (https://community.openhab.org/t/synology-disk-usage-and-snmp-binding/65869)
I wasn't able to test SET

* Update bundles/binding/org.openhab.binding.snmp/README.md

Co-Authored-By: on4tux <[email protected]>

* Update README.md

* [http] Fixed NPE while executing background thread (openhab#5718)

* Don't execute when the binding is shutting down.

* Update README.md (openhab#5614)

* [squeezebox action] linter errors pass 2 (openhab#5476)

Signed-off-by: Brad Gilmer <[email protected]>

* [unleash-maven-plugin] Preparation for next development cycle.

* update OpenWebNet link, current link is dead (openhab#5921)

https://developer.legrand.com/uploads/2019/12/OWN_Intro_ENG.pdf

Co-authored-by: Kai Kreuzer <[email protected]>
Co-authored-by: Jan Hendriks <[email protected]>
Co-authored-by: marekhalmo <[email protected]>
Co-authored-by: bitDealer <[email protected]>
Co-authored-by: dirkbe <[email protected]>
Co-authored-by: Søren Thorsen <[email protected]>
Co-authored-by: Christoph Weitkamp <[email protected]>
Co-authored-by: Wouter Born <[email protected]>
Co-authored-by: mueller-ma <[email protected]>
Co-authored-by: Slawomir Jaranowski <[email protected]>
Co-authored-by: CSchlipp <[email protected]>
Co-authored-by: André Heßling <[email protected]>
Co-authored-by: Arut42 <[email protected]>
Co-authored-by: Amos Kittelson <[email protected]>
Co-authored-by: pali <[email protected]>
Co-authored-by: paphko <[email protected]>
Co-authored-by: Peter Newman <[email protected]>
Co-authored-by: oktett-8 <[email protected]>
Co-authored-by: msimat <[email protected]>
Co-authored-by: Sem <[email protected]>
Co-authored-by: Michael Rumpf <[email protected]>
Co-authored-by: on4tux <[email protected]>
Co-authored-by: Chris Carman <[email protected]>
Co-authored-by: aurelio1 <[email protected]>
Co-authored-by: Brad Gilmer <[email protected]>
Co-authored-by: Thomas Manson <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@9037568 9037568 9037568 requested changes

@kaikreuzer kaikreuzer kaikreuzer approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@semperor @kaikreuzer @9037568