Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"Object" definition, etc. (3.1.1 port of #4050) #4052

Merged
merged 2 commits into from
Aug 28, 2024

Conversation

handrews
Copy link
Member

Includes two capitalizations (object -> Object) as a second commit on top of the ported commit.

Define capital-O "Object" to make it clear why it is only occasionally
capitalized.

Use lowercase "with" in titles consistently (it was more common than
capitalized "With".  This is one of those rules that is different
depending on whose style guide you use- about half the major guides
say always lowercase, the other say always captial.  We were using
lowercase more often.

Also, fix "Working with Examples" to be a subsection of the
Example Object as otherwise it breaks the pattern of all of the
headings of its level being Object definitions.  I remember messing
with this a lot when I first posted that PR and either I just
missed this or I had some reason I have now forgotten to do it
this way.
These got lower-cased because I did not explain in the text
that the capital is significant.  The previous commit adds the
explanation (ported from 3.0.4) and this fixes the 3.1.1-specific
occurrences.
@handrews handrews added editorial Wording and stylistic issues approved pr port PRs that just port an approved PR to another version labels Aug 27, 2024
@handrews handrews added this to the v3.1.1 milestone Aug 27, 2024
@handrews handrews requested a review from a team August 27, 2024 22:58
Copy link
Contributor

@mikekistler mikekistler left a comment

Choose a reason for hiding this comment

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

Looks good. 👍

@ralfhandl ralfhandl merged commit 8d677fe into OAI:v3.1.1-dev Aug 28, 2024
1 check passed
This was referenced Sep 2, 2024
@ralfhandl ralfhandl changed the title "Object" definition, etc. (3.1.1 port of #3050) "Object" definition, etc. (3.1.1 port of #4050) Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved pr port PRs that just port an approved PR to another version editorial Wording and stylistic issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants