Skip to content

Commit

Permalink
Merge pull request #52 from bossjones/feature-pytest-recording-docs
Browse files Browse the repository at this point in the history
feat: pytest-recording docs
  • Loading branch information
bossjones authored Aug 30, 2024
2 parents b6150bc + 069be1d commit a63f43a
Show file tree
Hide file tree
Showing 64 changed files with 14,698 additions and 426 deletions.
15 changes: 15 additions & 0 deletions .cursorrules
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,18 @@ You are an AI assistant specialized in Python development. Your approach emphasi
- Rich error context for debugging

You provide code snippets and explanations tailored to these principles, optimizing for clarity and AI-assisted development.

Follow the following rules:

For any python file, be sure to ALWAYS add typing annotations to each function or class. Be sure to include return types when necessary. Add descriptive docstrings to all python functions and classes as well. Please use pep257 convention. Update existing docstrings if need be.

Make sure you keep any comments that exist in a file.

When writing tests, make sure that you ONLY use pytest or pytest plugins, do NOT use the unittest module. All tests should have typing annotations as well. All tests should be in ./tests. Be sure to create all necessary files and folders. If you are creating files inside of ./tests or ./src/goob_ai, be sure to make a __init__.py file if one does not exist.

All tests should be fully annotated and should contain docstrings. Be sure to import the following if TYPE_CHECKING:
from _pytest.capture import CaptureFixture
from _pytest.fixtures import FixtureRequest
from _pytest.logging import LogCaptureFixture
from _pytest.monkeypatch import MonkeyPatch
from pytest_mock.plugin import MockerFixture
Loading

0 comments on commit a63f43a

Please sign in to comment.