Skip to content

Conversation

CharlesCNorton
Copy link
Contributor

@CharlesCNorton CharlesCNorton commented Jun 1, 2024

This PR corrects the placement of "only" and adds "the" in a Markdown cell.

These changes are necessary to adhere to proper grammatical rules, ensuring clarity and readability in the documentation. Proper grammar and clarity are essential for maintaining the quality and professionalism of the OpenAI Cookbook.


  • I have added a new entry in registry.yaml (and, optionally, in authors.yaml) so that my content renders on the cookbook website. (Not applicable)
  • I have conducted a self-review of my content based on the contribution guidelines:
    • Relevance: This content is related to building with OpenAI technologies and is useful to others.
    • Uniqueness: I have searched for related examples in the OpenAI Cookbook and verified that my content offers new insights or unique information compared to existing documentation. (Not applicable)
    • Spelling and Grammar: I have checked for spelling or grammatical mistakes.
    • Clarity: I have done a final read-through and verified that my submission is well-organized and easy to understand.
    • Correctness: The information I include is correct and all of my code executes successfully.
    • Completeness: I have explained everything fully, including all necessary references and citations.

Rephrase for clarity by moving "only" to its proper position and adding "the". The revised sentence reads: "We chose to leave a little ambiguity and noise in the dataset, even though we were interested only in the Summer Olympics 2020." According to the rule of correct placement for limiting modifiers, "only" should be placed immediately before the word or phrase it modifies to avoid ambiguity. Adding "the" ensures proper article usage.

  • The changes ensure that the documentation adheres to standard grammatical rules, enhancing readability and professionalism.
  • These improvements contribute to the overall quality of the OpenAI Cookbook, making it easier for users to understand and follow the examples.

@github-actions
Copy link

github-actions bot commented Aug 5, 2024

This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 10 days.

@github-actions github-actions bot added the Stale label Aug 5, 2024
Rephrase for clarity by moving "only" to its proper position and adding "the". The revised sentence reads: "We chose to leave a little ambiguity and noise in the dataset, even though we were interested only in the Summer Olympics 2020." According to the rule of correct placement for limiting modifiers, "only" should be placed immediately before the word or phrase it modifies to avoid ambiguity. Adding "the" ensures proper article usage.
Copy link
Collaborator

@ted-at-openai ted-at-openai left a comment

Choose a reason for hiding this comment

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

thank you! really appreciate you taking the time to help us improve the cookbook. apologies that this PR sat for so long.

@ted-at-openai ted-at-openai merged commit ef81a5d into openai:main Aug 5, 2024
nelsonauner pushed a commit to nelsonauner/openai-cookbook that referenced this pull request Aug 14, 2024
joshagilend pushed a commit to joshagilend/openai-cookbook that referenced this pull request Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants