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

Algorithms should be <dfn> in prose instead of linked to headers #618

Open
johnathan79717 opened this issue Aug 30, 2023 · 6 comments · May be fixed by #621
Open

Algorithms should be <dfn> in prose instead of linked to headers #618

johnathan79717 opened this issue Aug 30, 2023 · 6 comments · May be fixed by #621
Assignees

Comments

@johnathan79717
Copy link

The header "Does url match source list in origin with redirect count?" should be clickable and link to its references.

@antosart
Copy link
Member

antosart commented Sep 4, 2023

The same applies to several other links. It looks like adding dfn to the <h5> html element fixes it. I am not sure if that's "the right thing to do" or if there is a more appropriate way for algorithms.

@annevk
Copy link
Member

annevk commented Sep 4, 2023

That's a correct thing to do. (My personal preference is for headings to not be definitions, but they certainly can be.)

@antosart
Copy link
Member

antosart commented Sep 4, 2023

I think that makes sense. The spec currently mixes the two approaches, and there are a few algorithms defined in headings. It makes sense to fix it and actually define them in text. Since some of them are exported, we should fix the references in the call sites (mostly html I think). I'll try to fix this.

@mikewest
Copy link
Member

mikewest commented Sep 4, 2023

Linking to headers made sense to me at the time, but isn't what I'd do today given the tooling Bikeshed makes available. If I was writing it again, I'd use the "<dfn> in prose" approach, as y'all have suggested.

@johnathan79717
Copy link
Author

Sounds good to me as long as there is somewhere I can click and see where a certain algorithm is referenced. And consistency helps too.

@johnathan79717 johnathan79717 changed the title Header "Does url match source list in origin with redirect count?" does not link to its references. Algorithms should be Sep 5, 2023
@johnathan79717 johnathan79717 changed the title Algorithms should be Algorithms should be <dfn> in prose instead of linked to headers Sep 5, 2023
@antosart
Copy link
Member

antosart commented Sep 6, 2023

I went through the whole spec, since there are quite a few algorithms in headers (in particular, all the directive checks), I think the easiest thing to do is to just add dfn everywhere.

@antosart antosart linked a pull request Sep 6, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants