Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Analyze exported informative non-dfn-type dfns #256

Open
tidoust opened this issue Dec 20, 2022 · 0 comments
Open

Analyze exported informative non-dfn-type dfns #256

tidoust opened this issue Dec 20, 2022 · 0 comments
Labels
Definition checks

Comments

@tidoust
Copy link
Member

tidoust commented Dec 20, 2022

While there may be good reasons for specs to export informative terms (e.g. the Internationalization glossary), there should be limited reasons for a spec to export an informative term that is not a dfn type of definition.

Looking at data in Webref yields the following list of informative, non-dfn, and exported terms across specs. Many of them seem to be due to sections being incorrectly flagged as informative. For instance:

  • Web Bluetooth defines IDL names in "Notes" sections, which seems wrong.
  • Event Timing ends up defining IDL attribute in an informative section mostly by accident
  • WebRTC specs define event names in informative sections and it's not clear why.

In other cases, the informative nature of the definition is warranted, e.g. obsolete dictionaries members in WebRTC stats, but probably these terms should not be exported. These may disappear if ReSpec stops auto-exporting informative terms by default (see https://github.com/w3c/respec/issues/4349)

That could be something that Strudy ends up analyzing and reporting on.

css-gcpm-3
css-nav-1
css-overflow-4
event-timing
geolocation
html
mediacapture-streams
miniapp-lifecycle
overscroll-scrollend-events
tracking-dnt
web-bluetooth
webrtc-ice
webrtc-identity
webrtc-stats
webrtc
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
Definition checks
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dontcallmedom @tidoust