search

openhab / openhab-docs

This repository contains the documentation for openHAB.
https://www.openhab.org/docs/
Other
268 stars 683 forks source link

Astro binding description is incomplete or cut off #354

Closed ShaunCurrier closed 5 years ago

ShaunCurrier commented 7 years ago

On this page: http://docs.openhab.org/addons/bindings.html

The Astro binding is used for calculating

watou commented 7 years ago

The source README.md must have its description paragraph all on one line. Please re-open the issue or submit a PR against

https://github.com/openhab/openhab2-addons/blob/master/addons/binding/org.openhab.binding.astro/README.md

Thanks!

ShaunCurrier commented 7 years ago

OK will do.

I assume it's the same for netatmo's problems in the same page.

ThomDietrich commented 7 years ago

@ShaunCurrier I've talked about this with @watou before. Most of these READMEs need to be edited to have a clear introduction sentence. We also need to take care of Binding READMEs which begin with a list or an image. I wanted to look into this but am swamped with other projects and ideas right now. Feel free to take this on!!

Ideally every Binding starts with a clear description of it's purpose, the product or project it is related to, ideally a webpage link and if possible a mentioning of the field of interest. The description should not begin with something like "This binding is ..." or "This is an openHAB ...", feels like this will be redundant most of the time.

AngelosF commented 5 years ago

Close this Issue?

This looks ok to me: https://github.com/eclipse/smarthome/blob/master/extensions/binding/org.eclipse.smarthome.binding.astro/README.md

Confectrician commented 5 years ago

Yep. thanks.