Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update configuration.rst to show minimalistic config example #2990

Merged
merged 3 commits into from
Nov 19, 2024

Conversation

vkuehn
Copy link
Contributor

@vkuehn vkuehn commented Nov 18, 2024

As dicussed in the issue #2987 a minimalistic eample of config would prevent a reoccurence

@cyberw
Copy link
Collaborator

cyberw commented Nov 18, 2024

No Options are selected which would make Locust run e.g. headless or distributed

Adding an example is good, but headless and distributed options do exactly what they do on command line, so there's no need to mention them specifically, is there?

I know they threw you off a little bit, but with this example, hopefully this is less likely to happen.

@vkuehn
Copy link
Contributor Author

vkuehn commented Nov 19, 2024

@cyberw The reason to add this example was that starting with Locust comming from command line lead into a trap with the existing example., It took me while and help of an issue here to find out that the existing example would simple not work as it relies to TAG, MASTER..
so the intention was to add a most simple working example matching the locust.py example in the docs

@cyberw
Copy link
Collaborator

cyberw commented Nov 19, 2024

I know what you're trying to achieve, but "No Options are selected which would make Locust run e.g. headless or distributed" makes no sense, because headless is completely valid in a config file and distributed settings can be. Plus it is not grammatically correct so I'm not sure what you even mean...

@vkuehn
Copy link
Contributor Author

vkuehn commented Nov 19, 2024

you are right headless should be in a config file.

@cyberw
Copy link
Collaborator

cyberw commented Nov 19, 2024

I'm not saying it needs to be in the config file, I'm saying this sentence is misleading "No Options are selected which would make Locust run e.g. headless or distributed."

@vkuehn
Copy link
Contributor Author

vkuehn commented Nov 19, 2024

sorry misunderstood that. Actually the whole sentence could be removed and just add a small example which would be useable when comming from the commandline examples straight

@cyberw cyberw merged commit dac692d into locustio:master Nov 19, 2024
17 checks passed
@cyberw
Copy link
Collaborator

cyberw commented Nov 19, 2024

thx!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants