docs: extend project parameter description #1504
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
|
This comment was marked as outdated.
This comment was marked as outdated.
jennifer-shehane
approved these changes
Jul 18, 2025
|
🎉 This PR is included in version 6.10.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Situation
The description for the project parameter is open to misinterpretation, particularly in relation to whether it points to a complete project or just a set of Cypress tests
The CLI description for cypress run --project lacks explanation and the linked repo https://github.com/cypress-io/cypress-test-nested-projects is outdated (legacy v9 Cypress), fails to run and is archived. Issue archived legacy failing example used to demonstrate / explain
projectcli option cypress-documentation#5322 remains unaddressedChange
Add an description of usage and constraints for the successful use of the
projectparameter into the README > Project section:Ensure related references are consistently described