w3c / wot-thing-description

Web of Things (WoT) Thing Description
http://w3c.github.io/wot-thing-description/
Other
131 stars 63 forks source link

Add text regarding choosing between events and observable properties #2018

Closed JKRhb closed 1 month ago

JKRhb commented 1 month ago

Resolves #1818.


Preview | Diff

JKRhb commented 1 month ago

I was a bit unsure where to put the explanation – so far, I added it to the bottom of the section on EventAffordances, but this could maybe also become part of an appendix or a more general section on best practices for TD design.

egekorkan commented 1 month ago

The PR is fine, will be merged async after rebasing

JKRhb commented 1 month ago

Hmm, for some reason, the version I generate locally is now even more different from the main branch branch than before :/ To simplify things, I would simply remove my regeneration commit, and we could then have a clean version generated on the main branch, for example.

egekorkan commented 1 month ago

I have merged my latest pr so maybe that messed it up. If you want, please create a new PR with the same changes and we can merge async

JKRhb commented 1 month ago

I have merged my latest pr so maybe that messed it up. If you want, please create a new PR with the same changes and we can merge async

Hmm, do you mean a PR that regenerates the current state on the main branch? Otherwise, I could also “wrap” the commit that adds the text to the .ttl file in between two regeneration commits, the latter of which would illustrate the changes that would be added to the main document.

egekorkan commented 1 month ago

Ok I have understood the problem. Basically, if you render, the index.html generated does not follow our prettify rules so it overwrites the previous formatting. Once I ran formatting after rendering, the unwanted changes were gone. I hope that we will not have these small but annoying issues with new tooling.