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

Replace angle brackets in example code by proper unicode symbol #601

Closed
ThomDietrich opened this issue Dec 22, 2017 · 0 comments
Closed

Comments

@ThomDietrich
Copy link
Member

ThomDietrich commented Dec 22, 2017

Example code is full of placeholders, e.g. http://docs.openhab.org/configuration/sitemaps.html#element-type-switch

Switch item=<itemname> [label="<labelname>"] [icon="<iconname>"]

The use of <> is confusing in certain situations. I just realized that another symbol (unicode) is commonly used for these cases. http://www.fileformat.info/info/unicode/char/3008/index.htm

Switch item=〈itemname〉 [label="〈labelname〉"] [icon="〈iconname〉"]

If the introduced space is not desired, we can also go with http://www.fileformat.info/info/unicode/char/2329/index.htm

Switch item=〈itemname〉 [label="〈labelname〉"] [icon="〈iconname〉"]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants