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

Test all of our documentation. #404

Merged
merged 19 commits into from
Feb 5, 2024
Merged

Test all of our documentation. #404

merged 19 commits into from
Feb 5, 2024

Conversation

jxnl
Copy link
Owner

@jxnl jxnl commented Feb 5, 2024

We just need to run this command and continue tackling some of the problems:
pytest tests/openai/docs --update-examples


Ellipsis 🚀 This PR description was created by Ellipsis for commit 97d9c02.

Summary:

This PR updates documentation and test files, improving code snippets, adjusting formatting, and updating the output of certain examples.

Key points:

  • Updated formatting and code snippets in various documentation files.
  • Updated the output of certain code examples in the documentation.
  • Added a command to run pytest for documentation testing.

Generated with ❤️ by ellipsis.dev

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a 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

@@ -1,14 +1,24 @@
from math import e
Copy link
Contributor

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.

@jxnl jxnl merged commit dcb84b1 into main Feb 5, 2024
17 checks passed
@jxnl jxnl deleted the pytest-examples branch February 5, 2024 21:42
@@ -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
Copy link
Contributor

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.

Copy link
Owner Author

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"

Copy link
Contributor

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.

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.

None yet

2 participants