Skip to content

Conversation

@handrews
Copy link
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.

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 handrews added the editorial Wording and stylistic issues label Jun 13, 2024
@handrews handrews added this to the v3.0.4 milestone Jun 13, 2024
@handrews handrews requested a review from a team June 13, 2024 20:25
ralfhandl
ralfhandl previously approved these changes Jun 14, 2024
@ralfhandl ralfhandl requested a review from a team June 14, 2024 12:42
@mikekistler
Copy link
Contributor

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

Should those be changed to "OpenAPI description"?

@handrews
Copy link
Member Author

@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 review June 18, 2024 09:44

Waiting for changes suggested by Mike

@handrews handrews changed the title Use document/description/definition consistently Use document/description/definition consistently (3.0.4) Jun 19, 2024
@ralfhandl ralfhandl requested a review from mikekistler June 20, 2024 09:39
Copy link
Contributor

@lornajane lornajane left a comment

Choose a reason for hiding this comment

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

Thanks @handrews . Words matter!

@lornajane lornajane merged commit 0a1cb43 into OAI:v3.0.4-dev Jun 20, 2024
@handrews handrews deleted the doc-desc-304 branch June 20, 2024 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

editorial Wording and stylistic issues

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants