Skip to content

Conversation

Youshin
Copy link

@Youshin Youshin commented Sep 4, 2024

Summary

The following files in the Azure examples section contain typo corrections:

  • examples/azure/chat_with_your_own_data.ipynb
  • examples/azure/embeddings.ipynb
  • examples/azure/functions.ipynb
  • examples/azure/whisper.ipynb

Typos corrected:

  • “prequisites” changed to “prerequisites”
  • “autheticate” changed to “authenticate”

Motivation

These changes are necessary to improve the accuracy and professionalism of the documentation. Correct spelling improves readability and ensures that the content appears polished and error-free, which enhances user experience and trust in the material. By fixing these typos, the cookbook becomes clearer and more accessible to users, especially those learning how to work with OpenAI and Azure services.

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.

Youshin and others added 2 commits September 4, 2024 18:16
- prequisites to prerequisites
- autheticate to authenticate
@shyamal-anadkat shyamal-anadkat merged commit 827ec1f into openai:main Oct 14, 2024
@Youshin Youshin deleted the fix-typos branch October 15, 2024 00:03
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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants