-
Notifications
You must be signed in to change notification settings - Fork 11.1k
fix prompt typos #2033
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
base: main
Are you sure you want to change the base?
fix prompt typos #2033
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR fixes several typos and formatting issues in the GPT-5 prompting guide. The changes improve the readability and accuracy of the documentation by correcting spelling errors, fixing URLs, and cleaning up duplicated content.
- Corrected spelling errors including "typos" to "typos" and grammar fixes
- Fixed URL formatting by adding missing "https://" protocol
- Removed duplicated section content and cleaned up formatting
- Added proper markdown link formatting for ZDR organizations reference
Comments suppressed due to low confidence (1)
examples/gpt-5/gpt-5_prompting_guide.ipynb:13
- There's a double space between 'uncover' and 'ambiguities' in the original text that should be corrected to a single space.
"We’ve seen significant gains from applying these best practices and adopting our canonical tools whenever possible, and we hope that this guide, along with the [prompt optimizer tool](https://platform.openai.com/chat/edit?optimize=true) we’ve built, will serve as a launchpad for your use of GPT-5. But, as always, remember that prompting is not a one-size-fits-all exercise - we encourage you to run experiments and iterate on the foundation offered here to find the best solution for your problem."
@@ -19,7 +19,7 @@ | |||
"source": [ | |||
"## Agentic workflow predictability \n", | |||
"\n", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The double period '..' at the end of the sentence has been correctly removed, but this appears to be an intentional fix rather than an error in the current change.
Copilot uses AI. Check for mistakes.
@@ -300,7 +298,7 @@ | |||
"- Changing auto-assignment to occur after contacting a patient, auto-assign the earliest same-day slot after informing the patient of your actions. to be consistent with only scheduling with consent.\n", | |||
"- Adding Do not do lookup in the emergency case, proceed immediately to providing 911 guidance. to let the model know it is ok to not look up in case of emergency.\n", | |||
"\n", | |||
"We understand that the process of building prompts is an iterative one, and many prompts are living documents constantly being updated by different stakeholders - but this is all the more reason to thoroughly review them for poorly-worded instructions. Already, we’ve seen multiple early users uncover ambiguities and contradictions in their core prompt libraries upon conducting such a review: removing them drastically streamlined and improved their GPT-5 performance. We recommend testing your prompts in our [prompt optimizer tool](platform.openai.com/chat/edit?optimize=true) to help identify these types of issues.\n", | |||
"We understand that the process of building prompts is an iterative one, and many prompts are living documents constantly being updated by different stakeholders - but this is all the more reason to thoroughly review them for poorly-worded instructions. Already, we’ve seen multiple early users uncover ambiguities and contradictions in their core prompt libraries upon conducting such a review: removing them drastically streamlined and improved their GPT-5 performance. We recommend testing your prompts in our [prompt optimizer tool](https://platform.openai.com/chat/edit?optimize=true) to help identify these types of issues.\n", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's still a double space between 'uncover' and 'ambiguities' that needs to be corrected to a single space.
Copilot uses AI. Check for mistakes.
@@ -329,7 +327,7 @@ | |||
"Occasionally, adherence to Markdown instructions specified in the system prompt can degrade over the course of a long conversation. In the event that you experience this, we’ve seen consistent adherence from appending a Markdown instruction every 3-5 user messages.\n", | |||
"\n", | |||
"### Metaprompting\n", | |||
"Finally, to close with a meta-point, early testers have found great success using GPT-5 as a meta-prompter for itself. Already, several users have deployed prompt revisions to production that were generated simply by asking GPT-5 what elements could be added to an unsuccessful to elicit a desired behavior, or removed to prevent an undesired one.\n", | |||
"Finally, to close with a meta-point, early testers have found great success using GPT-5 as a meta-prompter for itself. Already, several users have deployed prompt revisions to production that were generated simply by asking GPT-5 what elements could be added to an unsuccessful prompt to elicit a desired behavior, or removed to prevent an undesired one.\n", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The word 'unsuccessful' should be followed by 'prompt' to complete the sentence properly, which has been correctly added in this change.
Copilot uses AI. Check for mistakes.
Summary
Briefly describe the changes and the goal of this PR. Make sure the PR title summarizes the changes effectively.
Motivation
Why are these changes necessary? How do they improve the cookbook?
For new content
When contributing new content, read through our contribution guidelines, and mark the following action items as completed:
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.