Skip to content

Use document/description/definition consistently (3.0.4) - #3908

Merged
lornajane merged 2 commits into
OAI:v3.0.4-devfrom
handrews:doc-desc-304
Jun 20, 2024
Merged

Use document/description/definition consistently (3.0.4)#3908
lornajane merged 2 commits into
OAI:v3.0.4-devfrom
handrews:doc-desc-304

Conversation

@handrews

@handrewshandrews commented Jun 13, 2024

Copy link
Copy Markdown
Member

This tries to be consistent about using "describe" rather than "define" and using "description" for the entire potentially-multi-document thing, and "document" (or sometimes "description document") to refer to individual documents in the description.

@handrews
Use document/description/definition consistently
5805283
This tries to be consistent about using "describe" rather than "define"
and using "description" for the entire potentially-multi-document
thing, and "document" (or sometimes "description document") to
refer to individual documents in the description.
@handrewshandrews added the editorial Wording and stylistic issues label Jun 13, 2024
@handrewshandrews added this to the v3.0.4 milestone Jun 13, 2024
@handrews
handrews requested a review from a teamJune 13, 2024 20:25
ralfhandl
ralfhandl previously approved these changes Jun 14, 2024
View reviewed changes
@ralfhandl
ralfhandl requested a review from a teamJune 14, 2024 12:42
mikekistler
mikekistler reviewed Jun 17, 2024
View reviewed changes
Comment threadversions/3.0.4.md
@handrewshandrews mentioned this pull request Jun 17, 2024
Closed
@mikekistler

mikekistler commented Jun 17, 2024

Copy link
Copy Markdown

There are still a couple instances of "OpenAPI definition" in the file:

Should those be changed to "OpenAPI description"?

@handrews

handrews commented Jun 17, 2024

Copy link
Copy Markdown
MemberAuthor

@mikekistler

Should those be changed to "OpenAPI description"?

Probably yes! Good catch- I'll take a look and update.

@ralfhandl
ralfhandl self-requested a review June 18, 2024 09:43
@ralfhandl
ralfhandl dismissed their stale reviewJune 18, 2024 09:44

Waiting for changes suggested by Mike

@handrewshandrews changed the title Use document/description/definition consistentlyUse document/description/definition consistently (3.0.4)Jun 19, 2024
lornajane
lornajane approved these changes Jun 20, 2024
View reviewed changes

@lornajanelornajane left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @handrews . Words matter!

Comment threadversions/3.0.4.md
@lornajane
lornajane merged commit 0a1cb43 into OAI:v3.0.4-devJun 20, 2024
@handrews
handrews deleted the doc-desc-304 branch June 20, 2024 20:32
@handrewshandrews mentioned this pull request Jun 21, 2024
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lornajanelornajanelornajane approved these changes
@ralfhandlralfhandlralfhandl approved these changes
@mikekistlermikekistlerAwaiting requested review from mikekistler

Assignees

No one assigned

Labels

editorialWording and stylistic issues

Projects

None yet

Milestone

v3.0.4

Development

Successfully merging this pull request may close these issues.

4 participants

@handrews@mikekistler@lornajane@ralfhandl