Skip to content
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

documentation for examples are added #842

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

Arundas666
Copy link
Contributor

@Arundas666 Arundas666 commented Sep 4, 2024

Describe the change
This PR adds documentation to the examples in the examples/ folder. The documentation provides clear explanations of each example's functionality and usage, making it easier for users to understand and utilize the examples.

Provide OpenAI documentation link
No changes to the OpenAI API were made, so no documentation link is necessary.

Describe your solution
The documentation was added as comments within the example files. The goal was to make the examples more accessible to users by providing context and instructions directly in the code and accompanying documents.

Tests
The changes consist solely of documentation updates, so no new tests were added. However, the examples themselves were run to ensure they function as expected.

Additional context
This PR does not introduce any functional changes to the codebase, only documentation improvements. This should make it easier for developers to use the examples provided.

Issue: #XXXX

Copy link

codecov bot commented Sep 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.01%. Comparing base (774fc9d) to head (1c25e4b).
Report is 47 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #842      +/-   ##
==========================================
+ Coverage   98.46%   99.01%   +0.55%     
==========================================
  Files          24       26       +2     
  Lines        1364     1418      +54     
==========================================
+ Hits         1343     1404      +61     
+ Misses         15        8       -7     
  Partials        6        6              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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