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

Doc tweaks #364

Closed
Dantenz opened this issue Feb 10, 2023 · 3 comments
Closed

Doc tweaks #364

Dantenz opened this issue Feb 10, 2023 · 3 comments
Assignees
Labels
documentation Something about the HABApp documentation

Comments

@Dantenz
Copy link

Dantenz commented Feb 10, 2023

I tried to push some changes for PR, but it seems the repo is locked down - so here's a ticket.

I ran into some major headaches when trying to use the set_metadata() function. The documentation for the namespace parameter currently says "namespace", which isn't very useful. I ended up searching the internet for some time trying to find out what an acceptable value would be and in the end figured it out by playing around with the OpenHAB UI. My recommendations for change are:

docs/interface_openhab.rst

======================================
If referring to namespaces, a full list can be found in the `openHAB repo
<https://github.com/openhab/openhab-webui/blob/main/bundles/org.openhab.ui/web/src/assets/definitions/metadata/namespaces.js>`_.

.. automodule:: HABApp.openhab.interface
   :members:
   :imported-members:

openhab/connection_handler/func_sync.py

    """
    Add/set metadata to an item

    :param item_name: name of the item or item
    :param namespace: namespace, e.g. stateDescription
    :param value: value
    :param config: configuration, e.g. {"options": "A,B,C"}
    :return: True if metadata was successfully created/updated
    """
@spacemanspiff2007 spacemanspiff2007 self-assigned this Feb 11, 2023
@spacemanspiff2007 spacemanspiff2007 added the documentation Something about the HABApp documentation label Feb 11, 2023
@spacemanspiff2007
Copy link
Owner

Thanks for the hint - I'll incorporate it in the next change.

I tried to push some changes for PR, but it seems the repo is locked down - so here's a ticket.

It's not possible to fork it and create a PR?

@Dantenz
Copy link
Author

Dantenz commented Feb 11, 2023

It's not possible to fork it and create a PR?

I'll do that next time 👍

@spacemanspiff2007
Copy link
Owner

Fixed in 1.1.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something about the HABApp documentation
Projects
None yet
Development

No branches or pull requests

2 participants