Skip to content

Fixed Typo in gpt-5_prompting_guide.ipynb #2060

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

realabdulkhaliq
Copy link

@realabdulkhaliq realabdulkhaliq commented Aug 14, 2025

Fixed some typos in gpt-5_prompting_guide.ipynb

This change improves the readability and professionalism of the text in the cookbook by correcting punctuation, ensuring it follows proper grammar rules. Clear, error-free documentation helps maintain a high-quality resource for readers.

Summary

Fixed minor typos and improved punctuation in the documentation:

Added a missing period to the sentence:
1
This reduces the model’s need to explore and reason about too many ideas:
to
This reduces the model’s need to explore and reason about too many ideas.
2
Deduplicate paths and cache; don’t repeat queries.
to
Deduplicate paths and cache, and don’t repeat queries.
3
you can find a sample planning prompt snippet we placed at the beginning of an agentic task:
to
you can find a sample planning prompt snippet we placed at the beginning of an agentic task.
4
to be consistent with only scheduling with consent.
to
To be consistent with only scheduling with consent.

Motivation

These changes enhance the clarity, readability, and grammatical accuracy of the cookbook’s documentation. Clear and polished text ensures that instructions are easy to follow and maintain a professional tone for all readers.


For new content

When contributing new content, read through our contribution guidelines, and mark the following action items as completed:

  • I have added a new entry in registry.yaml (and, optionally, in authors.yaml) so that my content renders on the cookbook website.
  • 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.
    • 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.

We will rate each of these areas on a scale from 1 to 4, and will only accept contributions that score 3 or higher on all areas. Refer to our contribution guidelines for more details.

Fixed some typos in gpt-5_prompting_guide.ipynb
Fixed minor typos and improved punctuation in the documentation:

Added a missing period to the sentence:
1
This reduces the model’s need to explore and reason about too many ideas:
to
This reduces the model’s need to explore and reason about too many ideas.
2
Deduplicate paths and cache; don’t repeat queries.
to
Deduplicate paths and cache, and don’t repeat queries.
3
you can find a sample planning prompt snippet we placed at the beginning of an agentic task:
to
you can find a sample planning prompt snippet we placed at the beginning of an agentic task.
4
to be consistent with only scheduling with consent.
to
To be consistent with only scheduling with consent.

This change improves the readability and professionalism of the text in the cookbook by correcting punctuation, ensuring it follows proper grammar rules. Clear, error-free documentation helps maintain a high-quality resource for readers.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant