Update docs for maintainers #499
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jhamon
force-pushed
the
jhamon/document-dotenv
branch
from
1300269 to
bd5d5a0
Compare
austin-denoble
approved these changes
May 21, 2025
docs/maintainers/testing-guide.md
Outdated
| └── upgrade | ||
| ``` | ||
|
|
||
| - `dependency`: These tests are a set of very minimal end-to-end integration tests that ensure basic functionality works to upsert and query vectors from an index. These are rarely run locally; we use them in CI to confirm the client can be used when installed wtih a large matrix of different python versions and versions of key dependencies. See [`.github/workflows/testing-dependency.yaml`](https://github.com/pinecone-io/pinecone-python-client/blob/main/.github/workflows/testing-dependency.yamll) for more details on how these are run. |
There was a problem hiding this comment.
nit: installed wtih -> installed with
docs/maintainers/testing-guide.md
Outdated
| └── upgrade | ||
| ``` | ||
|
|
||
| - `dependency`: These tests are a set of very minimal end-to-end integration tests that ensure basic functionality works to upsert and query vectors from an index. These are rarely run locally; we use them in CI to confirm the client can be used when installed wtih a large matrix of different python versions and versions of key dependencies. See [`.github/workflows/testing-dependency.yaml`](https://github.com/pinecone-io/pinecone-python-client/blob/main/.github/workflows/testing-dependency.yamll) for more details on how these are run. |
There was a problem hiding this comment.
There's an extra "l" on the end of testing-dependency.yamll here that needs to be dropped or this 404s, I think.
| - Run the tests in a single file: `poetry run pytest tests/integration/control/resources/index/test_create.py` | ||
| - Run a single test `poetry run pytest tests/integration/control/resources/index/test_list.py::TestListIndexes::test_list_indexes_includes_ready_indexes` | ||
|
|
||
| ### Fixtures and other test configuration |
There was a problem hiding this comment.
Really appreciate the depth and detail here, thank you!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
We need better docs on how to work in this repository.
Solution
Add information about testing and debugging.
Type of Change