docs(test-tools): Clarify installation instructions#80
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #80 +/- ##
=======================================
Coverage 94.17% 94.17%
=======================================
Files 74 74
Lines 2147 2147
=======================================
Hits 2022 2022
Misses 125 125 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
matthewelwell
requested changes
May 27, 2025
| #### Installation | ||
|
|
||
| 1. To make use of the `test_tools` Pytest plugin, install the packages with the `test-tools` extra, e.g. `pip install flagsmith-common[test-tools]`. | ||
| 1. As a dev dependency, install the package with the `test-tools` extra, e.g. `poetry add --G dev flagsmith-common[test-tools]`. This will enable the Pytest fixtures. Skipping this step will make Pytest collection fail due to missing dependencies. |
Contributor
There was a problem hiding this comment.
I think this could be clearer still. These instructions are the general installation instructions so it's odd to start with 'As a dev dependency'.
I think we should just write something like:
pip install flagsmith-common
poetry add --G dev flagsmith-common[test-tools]- this is needed because x & y.
matthewelwell
approved these changes
May 27, 2025
This was referenced Jul 29, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
No description provided.