Skip to content

Preserve rfc section links - #3956

Merged
ralfhandl merged 4 commits into
OAI:mainfrom
ralfhandl:preserve-rfc-section-links
Jul 25, 2024
Merged

Preserve rfc section links#3956
ralfhandl merged 4 commits into
OAI:mainfrom
ralfhandl:preserve-rfc-section-links

Conversation

@ralfhandl

@ralfhandlralfhandl commented Jul 15, 2024

Copy link
Copy Markdown
Contributor

Fixes#3863

See for example

Unless specified otherwise, all properties that are URIs MAY be relative references as defined by [RFC3986] Section 4.2.

@ralfhandlralfhandl added the editorial Wording and stylistic issues label Jul 15, 2024
@ralfhandlralfhandl added script Pull requests that update Bash or JavaScript code javascript Pull requests that update Javascript code labels Jul 23, 2024
@ralfhandl
ralfhandl marked this pull request as ready for review July 23, 2024 13:46
@ralfhandl
ralfhandl requested review from a team as code ownersJuly 23, 2024 13:46
@ralfhandl
ralfhandl requested a review from handrewsJuly 23, 2024 13:48
@ralfhandlralfhandl removed the script Pull requests that update Bash or JavaScript code label Jul 23, 2024

@mikekistlermikekistler left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Looks good. 👍

@handrewshandrews left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Minor comments, but I'm fine with this going in.

Comment on lines +277 to +282
//TODO: unconventional references to RFCs in 3.0.4 and 3.1.1, for example
// [RFC3986 §5.1.2 – 5.1.4](https://tools.ietf.org/html/rfc3986#section-5.1.2)
// RFC6570 [mentions](https://www.rfc-editor.org/rfc/rfc6570.html#section-2.4.2)
// [are not](https://datatracker.ietf.org/doc/html/rfc3986#appendix-A)
// [special behavior](https://www.rfc-editor.org/rfc/rfc1866#section-8.2.1)
// [RFC6570 considers to be _undefined_](https://datatracker.ietf.org/doc/html/rfc6570#section-2.3)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm entirely fine with making these more normal rather than working around them in the build script.

Comment on lines +292 to +293
//TODO: non-link mentions of RFCs in 3.0.4 and 3.1.1, for example
// RFC3986's definition of [reserved](https://datatracker.ietf.org/doc/html/rfc3986#section-2.2)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Also fine with these being made more typical.

Comment on lines -311 to +329
if (Math.abs(delta)>1) console.warn(delta,line);
// if (Math.abs(delta)>1) console.warn(delta,line);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Any particular reason to keep this line as a comment instead of delete?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Reverence for @MikeRalphson 😄

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Will remove them in a future PR

@ralfhandl
ralfhandl merged commit 465fcb3 into OAI:mainJul 25, 2024
@ralfhandl
ralfhandl deleted the preserve-rfc-section-links branch July 25, 2024 16:57
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

editorialWording and stylistic issuesjavascriptPull requests that update Javascript code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Preserve section links in ReSpec output

3 participants

@ralfhandl@handrews@mikekistler