-
-
Notifications
You must be signed in to change notification settings - Fork 602
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
Test all of our documentation. #404
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.
Changes requested.
Something look wrong? You can customize Ellipsis by editing the ellipsis.yaml for this repository.
Generated with ❤️ by ellipsis.dev
tests/docs/test_docs.py
Outdated
@@ -1,14 +1,24 @@ | |||
from math import e |
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 import statement 'from math import e' seems unnecessary as 'e' is not used anywhere in the file. Consider removing it to keep the code clean and avoid confusion.
@@ -2,5 +2,3 @@ version: 0.0.1 | |||
patterns: | |||
- name: github.com/getgrit/python#openai | |||
level: info | |||
- name: github.com/getgrit/python#no_skipped_tests |
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.
@jxnl I would love your feedback on why you removed this.
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.
had to skip some tests that are not passing right now, i thought it was "no skipped tests without reasons"
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.
Oh, no it forbids all skipped tests right now. Can adjust.
We just need to run this command and continue tackling some of the problems:
pytest tests/openai/docs --update-examples
Summary:
This PR updates documentation and test files, improving code snippets, adjusting formatting, and updating the output of certain examples.
Key points:
Generated with ❤️ by ellipsis.dev