search

openai / openai-python

The official Python library for the OpenAI API
https://pypi.org/project/openai/
Apache License 2.0
22.2k stars 3.08k forks source link

Just updated the README.md file to make it easier for people to understand like novices like myself, it explains what things are, what they do. #1556

Closed davidtkeane closed 2 months ago

davidtkeane commented 2 months ago

Confirm this is a feature request for the Python library and not the underlying OpenAI API.

Describe the feature or improvement you're requesting

Enhanced README.md with Teen-Friendly Explanations.

N.B if needed i can complete the readme and have all the internal hyperlinks working to connect to the Quick Definitions section. And to have these links in blue for people to learn.

Summary This pull request updates the README.md file, specifically enhancing the Pagination section with additional explanations tailored for younger audiences (around 15 years old). The changes aim to make the documentation more accessible and easier to understand for newcomers to the OpenAI API and programming concepts. Changes Made

Added emoji-prefixed explanations after each code block in the Pagination section. Introduced relatable analogies (e.g., books, relay races, encyclopedias) to explain complex concepts. Maintained the original code examples and structure while improving readability. Ensured explanations cover both synchronous and asynchronous pagination methods.

Benefits

Improves accessibility of the documentation for younger developers or those new to API concepts. Provides clear, relatable explanations without sacrificing technical accuracy. Enhances overall user experience by making complex topics more approachable.

Additional context

This is 90% finished, but wanted to share before i finished if this is not needed, but love helping out and making the README easier to understand by new users who know nothing (Just like myself!) README.md

### Tasks
RobertCraigie commented 2 months ago

@davidtkeane please open a PR so we can review the changes more easily, it doesn't matter if it's not finished yet :)

davidtkeane commented 2 months ago

@davidtkeane please open a PR so we can review the changes more easily, it doesn't matter if it's not finished yet :)

@RobertCraigie

Thank you Robert for the encouragement. I will continue to finish the document and see what happens. A PR has been created https://github.com/openai/openai-python/pull/1555

Thanks again!

Kind regards,

David.