Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiple binding markdown fixes #17422

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

lsiepel
Copy link
Contributor

@lsiepel lsiepel commented Sep 15, 2024

  • Fixes some SAT warnings about markdown.
  • Reformatted some tables. (no change to content, just whitespaces)
  • Fixes some icons missing in the docs folder cuasing 404's.
  • Fixes some duplicate headers in the docs, causing anchor tags to fail.

Signed-off-by: Leo Siepel <[email protected]>
Signed-off-by: Leo Siepel <[email protected]>
bundles/org.openhab.binding.warmup/README.md Outdated Show resolved Hide resolved
@@ -87,7 +86,7 @@ At the very least, you cannot use repeating (111-11-111) or sequential (123-45-6

Other settings, such as using Fahrenheit temperatures and specifying the interface to advertise the HomeKit bridge are also illustrated in the following sample:

```
```perl
Copy link
Contributor

Choose a reason for hiding this comment

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

Why perl ?

Same question for the other places where you added it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

.cfg files are not listed in the post that is used as base (for reference: openhab/openhab-docs#999)
As there does not seem to be a preferred one, i choose this as it seems a decent fit. For instance it uses the same comment #
But i'm, open for other suggestions.

- `sendNotification(emailAddress, message)`: Send a notification to a _specific_ openHAB Cloud user.
- `sendBroadcastNotification(message)`: Send a broadcast notification to _all_ devices of _all_ users.
- `sendLogNotification(message)`: Send a log notification to the notifications list. Log notifications do not trigger a notification on the device.
* `sendNotification(emailAddress, message)`: Send a notification to a _specific_ openHAB Cloud user.
Copy link
Contributor

Choose a reason for hiding this comment

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

Why in the previous file (homekit) you replaced * by - and here you do the reverse. The rendering seems to be identical, no ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

VS Code
The original value in homekit gave:

MD004/ul-style: Unordered list style [Expected: dash; Actual: asterisk]

The original value in openhabcloud gave:

MD004/ul-style: Unordered list style [Expected: asterisk; Actual: dash]

Both have the same issue/link: https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md004.md

I must admit i just applied the sugggestion here without looking into exact details why the markdownlint preferred different chars for a similar looking case, as it seemed fine. I have now looked into it in more detail and this is determined based on the first list in the readme. So it doesn't matter what char, as long as it is consistent in the particular file. As this solved the warnings, and the file is now consistent i think this is fine.

Signed-off-by: Leo Siepel <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants