search

ietf-wg-gnap / gnap-core-protocol

141 stars 26 forks source link

Editorial: references in running text #300

Closed yaronf closed 2 years ago

yaronf commented 3 years ago

Top of Sec. 5:

While it is possible for the AS to return a Section 3 with all the client instance's requested information

I think in the plain text version this would be "to return a response {Section 3}" but in the HTML rendering, this comes out incorrect. There are several more cases of this pattern. In Sec. 4:

the AS MAY return the positive results immediately in its Section 3 with access tokens and subject information.

fimbault commented 3 years ago

This pattern occurs for references that match the description, it seems. Each time we have a text like '[request] (#request)' or '[response] (#response)' (without the space)

I suggest we always use a composite namespace, such as access_request or grant_response to avoid the problem, but in we want this to be consistent, then many references will have to change as well (sub sections)

@jricher would that be fine for you?