Rework quickstart documentation and update some documentation for 1.0 #1384

cyberw · 2020-05-19T09:29:21Z

Also update some UI text.

…s important things, etc). Moved quickstart example code into separate locustfile. Update some comments for 1.0.

codecov · 2020-05-19T09:30:19Z

Codecov Report

❗ No coverage uploaded for pull request base (master@06266b2). Click here to learn what that means.
The diff coverage is 0.00%.

@@            Coverage Diff            @@
##             master    #1384   +/-   ##
=========================================
  Coverage          ?   79.91%           
=========================================
  Files             ?       26           
  Lines             ?     2459           
  Branches          ?      410           
=========================================
  Hits              ?     1965           
  Misses            ?      394           
  Partials          ?      100

Impacted Files	Coverage Δ
locust/main.py	`21.78% <0.00%> (ø)`
locust/user/task.py	`95.68% <ø> (ø)`
locust/user/users.py	`95.58% <ø> (ø)`
locust/user/wait_time.py	`100.00% <ø> (ø)`
locust/util/timespan.py	`87.50% <0.00%> (ø)`
locust/exception.py	`100.00% <0.00%> (ø)`
locust/argument_parser.py	`76.14% <0.00%> (ø)`
locust/user/__init__.py	`100.00% <0.00%> (ø)`
locust/log.py	`61.11% <0.00%> (ø)`
locust/web.py	`91.25% <0.00%> (ø)`
... and 20 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 06266b2...7cd00ea. Read the comment docs.

…t under User.

heyman

I've added a bunch of inline comments. There's some nice improvements across the PR, but I don't agree with some of the changes to the Quickstart docs.

docs/quickstart.rst

docs/writing-a-locustfile.rst

examples/nested_inline_tasksets.py

locust/main.py

examples/add_command_line_argument.py

locust/test/test_main.py

locust/user/task.py

locust/user/wait_time.py

…artUser instead of MyUser. some minor fixes/clarifications.

cyberw added 2 commits May 19, 2020 11:27

Rework quickstart documentation (shorter, important things before les…

544d31f

…s important things, etc). Moved quickstart example code into separate locustfile. Update some comments for 1.0.

Update some copy.

e59cf05

cyberw added 2 commits May 19, 2020 11:47

Fix a link, shorten some headings

d6a4b5e

The tasks attribute is mentioned under Tasks, no point in repeating i…

deb71ba

…t under User.

heyman requested changes May 19, 2020

View reviewed changes