Skip to content

3.2 typos and minor editorial changes - #4876

Merged
ralfhandl merged 1 commit into
OAI:v3.2-devfrom
ralfhandl:3.2-typos
Aug 20, 2025
Merged

3.2 typos and minor editorial changes#4876
ralfhandl merged 1 commit into
OAI:v3.2-devfrom
ralfhandl:3.2-typos

Conversation

@ralfhandl

@ralfhandlralfhandl commented Aug 16, 2025

Copy link
Copy Markdown
Contributor
  • no schema changes are needed for this pull request

@ralfhandlralfhandl added this to the v3.2.0 milestone Aug 16, 2025
@ralfhandl
ralfhandl requested review from a team as code ownersAugust 16, 2025 15:49
@ralfhandlralfhandl added the editorial Wording and stylistic issues label Aug 16, 2025
mikekistler
mikekistler previously approved these changes Aug 16, 2025

@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! 👍

@mikekistler
mikekistler requested a review from a teamAugust 16, 2025 19:04

@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.

@ralfhandl I really, really appreciate your thorough read-through here. I have some minor quibbles and questions, but nothing major and nothing I feel so strongly about as to really dig in if other folks are fine with it.

Comment threadsrc/oas.md Outdated
Comment threadsrc/oas.md Outdated
Comment threadsrc/oas.md
Comment threadsrc/oas.md Outdated
Comment threadsrc/oas.md Outdated
Comment threadsrc/oas.md
Comment threadsrc/oas.md Outdated
@ralfhandl

Copy link
Copy Markdown
ContributorAuthor

@handrews Let's discuss your questions, please comment on the changes you don't fully agree with.

Henry's remarks
Update src/oas.md
Better explanation for custom anchor
Co-Authored-By: Lorna Jane Mitchell <github@lornajane.net>
@handrews

Copy link
Copy Markdown
Member

@ralfhandl

@handrews Let's discuss your questions, please comment on the changes you don't fully agree with.

I think most things are now fine. I replied to the markdownlint section header problem elsewhere

That depends whether the media type mentioned in the comment is a field name or a field value.

There's also just using a media type as a media type regardless of its position. But in all three cases, it should be in backticks, just possibly also in quotes. I think. Like this:

  • Field name: text/event-stream
  • Field value: "text/event-stream"
  • Media type, regardless of position (or position ambiguous): text/event-stream

@handrewshandrews mentioned this pull request Aug 17, 2025
@ralfhandl

Copy link
Copy Markdown
ContributorAuthor

@mikekistler Could you please re-approve?

@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.

Re-approving.

@ralfhandl
ralfhandl merged commit bf0d54a into OAI:v3.2-devAug 20, 2025
2 checks passed
@ralfhandl
ralfhandl deleted the 3.2-typos branch August 20, 2025 15:55
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

editorialWording and stylistic issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants

@ralfhandl@handrews@lornajane@miqui@mikekistler