docs: add distributed mode limitations documentation #3231
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.
Description
This PR addresses issue #3203 by adding comprehensive documentation about the limitations of using
-f -(distributed locustfile) with multiple files.Changes
docs/distributed-limitations.rst-f -doesn't work with multiple filesWhy this change?
Issue #3203 highlighted that the current documentation mentions
-f -works for "single locustfiles" but doesn't clearly explain the implications for users with multi-file test structures. This leads to confusion andModuleNotFoundErrorwhen users try to import from other modules.Benefits
Documentation Structure
The new file covers:
This addresses the maintainer's comment that "serving multiple files is a bit thorny" by documenting the current limitations while providing practical alternatives.