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

Fix oh-icon icon name type in widget def & docs #3043

Merged
merged 2 commits into from
Feb 15, 2025

Conversation

jimtng
Copy link
Contributor

@jimtng jimtng commented Jan 28, 2025

No description provided.

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
Copy link
Member

@ghys ghys left a comment

Choose a reason for hiding this comment

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

Thanks, good catch, but you modified a generated doc:

<!-- DO NOT REMOVE the following comments -->
<!-- GENERATED props -->
### General
<div class="props">
<PropGroup label="General">
<PropBlock type="BOOLEAN" name="icon" label="Icon">
<PropBlock type="TEXT" name="icon" label="Icon">
...

You want to modify https://github.com/openhab/openhab-webui/blob/main/bundles/org.openhab.ui/web/src/assets/definitions/widgets/system/icon.js instead first (pb to pt), then regenerate the docs with the script described in
https://github.com/openhab/openhab-webui/blob/main/bundles/org.openhab.ui/CONTRIBUTING.md#documentation--resources

Signed-off-by: Jimmy Tanagra <jcode@tanagra.id.au>
@jimtng
Copy link
Contributor Author

jimtng commented Feb 2, 2025

Thanks! Learnt something new :)

In the process of running generate.js there were other changes, which I submitted as a separate commit.

Copy link

relativeci bot commented Feb 2, 2025

#2770 Bundle Size — 10.98MiB (0%).

ab2b8c8(current) vs 95844d2 main#2743(baseline)

Warning

Bundle contains 2 duplicate packages – View duplicate packages

Bundle metrics  Change 1 change
                 Current
#2770
     Baseline
#2743
No change  Initial JS 1.9MiB 1.9MiB
No change  Initial CSS 577.21KiB 577.21KiB
Change  Cache Invalidation 17.32% 17.51%
No change  Chunks 227 227
No change  Assets 250 250
No change  Modules 2952 2952
No change  Duplicate Modules 154 154
No change  Duplicate Code 1.8% 1.8%
No change  Packages 98 98
No change  Duplicate Packages 2 2
Bundle size by type  Change 7 changes Regression 7 regressions
                 Current
#2770
     Baseline
#2743
Regression  JS 9.19MiB (+100%) undefined
Regression  CSS 867.33KiB (+100%) undefined
Regression  Fonts 526.1KiB (+100%) undefined
Regression  Media 295.6KiB (+100%) undefined
Regression  IMG 140.74KiB (+100%) undefined
Regression  HTML 1.38KiB (+100%) undefined
Regression  Other 871B (+100%) undefined

Bundle analysis reportBranch jimtng:icon-docProject dashboard


Generated by RelativeCIDocumentationReport issue

@jimtng
Copy link
Contributor Author

jimtng commented Feb 2, 2025

In the process of running generate.js there were other changes, which I submitted as a separate commit.

Ughh, it seems that those changes shouldn't be there. I've removed them, so that this PR only contains changes to icon

@florian-h05 florian-h05 added the main ui Main UI label Feb 3, 2025
Copy link
Contributor

@florian-h05 florian-h05 left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@florian-h05 florian-h05 added this to the 5.0 milestone Feb 15, 2025
@florian-h05 florian-h05 changed the title Docs: Fix oh-icon icon name type Fix oh-icon icon name type in widget def & docs Feb 15, 2025
@florian-h05 florian-h05 added the bug Something isn't working label Feb 15, 2025
@florian-h05 florian-h05 merged commit 34679aa into openhab:main Feb 15, 2025
5 checks passed
@jimtng jimtng deleted the icon-doc branch February 15, 2025 13:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working main ui Main UI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants