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

Dependencies section is out of date and duplicates terms index #1797

Closed
emlun opened this issue Sep 8, 2022 · 1 comment · Fixed by #2039
Closed

Dependencies section is out of date and duplicates terms index #1797

emlun opened this issue Sep 8, 2022 · 1 comment · Fixed by #2039
Assignees
Labels

Comments

@emlun
Copy link
Member

emlun commented Sep 8, 2022

§3. Dependencies states that

This specification relies on several other underlying specifications, listed below and in Terms defined by reference.

It also states, for example:

HTML
The concepts of browsing context, origin, opaque origin, tuple origin, relevant settings object, and is a registrable domain suffix of or is equal to are defined in [HTML].

...but the Terms defined by reference section lists many more terms for most of these dependencies.

Should we attempt to keep these sections in sync, or should we move most details out of §3. Dependencies? The Terms defined by reference section is generated automatically and should always cover all references to other Bikeshed-covered specs, but the Dependencies section needs to be maintained manually. Specs outside of Bikeshed coverage (CBOR, CDDL, etc.) would still need to be listed manually in §3 Dependencies, though.

@nadalin
Copy link
Contributor

nadalin commented Aug 30, 2023

@ve7jtb please see if this is still relevant

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

Successfully merging a pull request may close this issue.

3 participants