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

xref: Some page visibility entries not showing up #202

Closed
marcoscaceres opened this issue May 26, 2021 · 7 comments · Fixed by #207
Closed

xref: Some page visibility entries not showing up #202

marcoscaceres opened this issue May 26, 2021 · 7 comments · Fixed by #207

Comments

@marcoscaceres
Copy link
Collaborator

The following entry for "external now visible algorithm" is not showing up in xref for some reason:

https://github.com/w3c/webref/blob/cd238a8986d9c1355ff200e29db21f896c72d43f/tr/dfns/page-visibility-2.json#L228-L244

@sidvishnoi
Copy link
Member

sidvishnoi commented May 26, 2021

It's private according to line 236 there. Should export it from the spec.

@marcoscaceres
Copy link
Collaborator Author

@marcoscaceres
Copy link
Collaborator Author

Ok, so, in any case, the bug is probably in WebRef as it's not picking them up as public.

@marcoscaceres marcoscaceres transferred this issue from speced/respec-web-services May 26, 2021
@tidoust
Copy link
Contributor

tidoust commented May 26, 2021

What is the exact definition you're looking for?

There are three distinct definitions:

  1. now visible algorithm
  2. now hidden algorithm
  3. external now visible algorithm

Definitions 1 and 2 are the ones you linked to. They are defined with a data-export attribute and are flagged as public in webref. Definition 3 is the one you seem to be looking for. It is defined through a simple <dfn> tag and is correctly flagged as private in webref as far as I can tell.

@marcoscaceres
Copy link
Collaborator Author

@tidoust, yes, you are correct about "external now visible algorithm".

For whatever reason, the other two are not showing up in xref:

But it's not a bug here... I'll move the issue over to Respec.

@marcoscaceres marcoscaceres transferred this issue from w3c/webref May 28, 2021
@sidvishnoi
Copy link
Member

They both have type: "abstract-op", we only support dfn. From Bikeshed:

abstract-op (for "English-language algorithms")
dfn (for general terms and phrases, and a catch-all for anything else)

How do you suggest going forward? Rename abstract-op to dfn in ReSpec data, or add a new supported search type (with potentially new syntax?)?

@sidvishnoi sidvishnoi changed the title Some page visibility entries not showing up xref: Some page visibility entries not showing up Jun 2, 2021
@marcoscaceres
Copy link
Collaborator Author

How do you suggest going forward? Rename abstract-op to dfn in ReSpec data, or add a new supported search type (with potentially new syntax?)?

I don't think we need a new syntax. We should treat them as dfn and link to them with [=the whatever algo=] (same as BS).

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.

3 participants