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

Editorial: align with Fetch's structured field changes #5732

Merged
merged 3 commits into from
Jul 17, 2020
Merged

Conversation

annevk
Copy link
Member

@annevk annevk commented Jul 14, 2020

@annevk
Copy link
Member Author

annevk commented Jul 14, 2020

It seems this is the only IETF document for which we reference httpwg.org and we only do so in HTML. It doesn't matter much, but any issue if I changed it to tools.ietf.org?

@domenic
Copy link
Member

domenic commented Jul 14, 2020

I'd slightly prefer to update all the other "structured header" references, e.g. in prose, at the same time. (And ideally even the data-x values?) Then this could close #5676. I don't insist though.

I'd prefer to go the other way around and use httpwg.org more, as it's infinitely more readable.

@annevk
Copy link
Member Author

annevk commented Jul 15, 2020

So "structured header" is still a valid term. It's just that in Fetch I want to be prepared for trailers. I'm not sure HTML needs to be. I could go either way though.

@domenic
Copy link
Member

domenic commented Jul 15, 2020

I think it'd be good to be consistent; otherwise the reader is left wondering. And e.g. [STRUCTURED-HEADERS] should be changed, and since the term "structured header" is not defined by the IETF document, it seems bad to say that it is.

@annevk
Copy link
Member Author

annevk commented Jul 15, 2020

It's not, it says so right in the Abstract and onward?

@annevk
Copy link
Member Author

annevk commented Jul 16, 2020

Can we land this then?

As for httpwg.org, I'd prefer an official IETF reference for longevity. It would be nice if IETF could format all their documents that way though.

@domenic
Copy link
Member

domenic commented Jul 16, 2020

I'd still prefer that we be consistent, and at least change the document title and citation name.

@annevk
Copy link
Member Author

annevk commented Jul 16, 2020

The document title is already correct, no? And changing the citation name would break links or there a way to avoid doing that?

@domenic
Copy link
Member

domenic commented Jul 16, 2020

You're right about the document title.

What links are you worried about breaking?

@annevk
Copy link
Member Author

annevk commented Jul 16, 2020

Into the references section?

@domenic
Copy link
Member

domenic commented Jul 16, 2020

If we just do s/STRUCTURED-HEADERS/STRUCTURED-FIELDS/g everywhere in the document, then all the [STRUCTURED-FIELDS] links will go to the new [STRUCTURED-FIELDS] part of the references section.

@annevk annevk requested a review from domenic July 16, 2020 16:52
@@ -80498,12 +80497,11 @@ interface <dfn>BarProp</dfn> {
<ol>
<li><p>Let <var>policy</var> be a new <span>embedder policy</span>.</p></li>

<li><p>Let <var>parsedItem</var> be the result of <span
data-x="concept-response-header-list-get-structured-header">getting a structured header</span>
<li><p>Let <var>parsedItem</var> be the result of <span>getting a structured field value</span>
with `<code>Cross-Origin-Embedder-Policy</code>` and "<code data-x="">item</code>".</p></li>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you'd like to fix this while you're here, it should be suffixed with "from response's [header list]"

@@ -80517,13 +80515,12 @@ interface <dfn>BarProp</dfn> {
</ol>
</li>

<li><p>Set <var>parsedItem</var> to the result of <span
data-x="concept-response-header-list-get-structured-header">getting a structured header</span>
<li><p>Set <var>parsedItem</var> to the result of <span>getting a structured field value</span>
with `<code>Cross-Origin-Embedder-Policy-Report-Only</code>` and "<code
data-x="">item</code>".</p></li>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto

@annevk annevk merged commit c0572d9 into master Jul 17, 2020
@annevk annevk deleted the annevk/fetch-sfv branch July 17, 2020 08:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants