Skip to content

Commit 9243fe3

Browse files
committed
Fix typos in detailed timing configuration documentation.
1 parent b05be23 commit 9243fe3

1 file changed

Lines changed: 20 additions & 15 deletions

File tree

docs/Detailed timing configuration.rst

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
Detailed timing configuration
22
*****************************
33

4+
This section describes the exact meaning of CMS parameters for
5+
controlling the time window allocated to each contestant. Please see
6+
:doc:`Configuring a contest` for a more gentle introduction and the
7+
intended usage of the various parameters.
8+
49
When setting up a contest, you will need to decide the time window in
510
which contestants will be able to interact with the contest (by
6-
reading statements, submit solutions, ...). In CMS, there are several
7-
parameters that allow to control this time window, and also allow to
8-
personalize it for every user in case it is needed.
11+
reading statements, submit solutions, ...). In CMS there are several
12+
parameters that allow to control this time window, and it is also
13+
possible to personalize it for each single user in case it is needed.
914

1015
The first decision to chose among these two possibilities:
1116

@@ -33,14 +38,14 @@ can use one of two slightly different per-contestant parameters:
3338

3439
You can use ``extra_time`` to award more time at the end of the
3540
contest for a specific contestant, whereas you can use ``delay_time``
36-
to shift in the future the time-window of the contest just for that
41+
to shift in the future the time window of the contest just for that
3742
user. There are two main practical differences between these two
3843
options.
3944

4045
#. If you set ``extra_time`` to S seconds, the contestant will be able
4146
to interact with the contest in the first S seconds of it, whereas
4247
if you use ``delay_time``, she will not, as in the first case the
43-
time-window is extended, in the second is shifted (if S seconds
48+
time window is extended, in the second is shifted (if S seconds
4449
have already passed from the start of the contest, then there is no
4550
difference).
4651

@@ -50,43 +55,43 @@ options.
5055
tokens are generated for contestants with ``extra_time``); if
5156
instead you set ``delay_time`` to S seconds, tokens for that
5257
contestants are generated at start_time + S + k*M (i.e., they are
53-
shifted from the original, and the same amount of tokens will be
54-
generated regardless of the other settings).
58+
shifted from the original, and the same amount of tokens as other
59+
contestants will be generated).
5560

5661
Of course it is possible to use both at the same time, but we do not
5762
see much value in doing so.
5863

5964
Customized-window contests
6065
==========================
6166

62-
In these contests, contestants can use a time-window of fixed length
67+
In these contests, contestants can use a time window of fixed length
6368
(``per_user_time``), starting from the first time they log in between
64-
start_time and end_time. Moreover, the time-window is capped at
69+
``start_time`` and ``end_time``. Moreover, the time window is capped at
6570
``end_time`` (so if ``per_user_time`` is 5 hours and a contestant logs
6671
in for the first time one minute before ``end_time``, she will have
6772
just one minute).
6873

69-
Again, admins can change the time-windows of specific contestants for
74+
Again, admins can change the time windows of specific contestants for
7075
fairness reasons. In addition to ``extra_time`` and ``delay_time``,
7176
they can also use ``starting_time``, which is automatically set by CMS
7277
when the contestant logs in for the first time.
7378

7479
The meaning of ``extra_time`` is to extend both the contestant
75-
time-window (as defined by ``starting_time`` + ``per_user_time``) and
76-
the contest time-window (as defined by ``end_time``) by the value of
80+
time window (as defined by ``starting_time`` + ``per_user_time``) and
81+
the contest time window (as defined by ``end_time``) by the value of
7782
``extra_time``, but only for that contestant. Therefore, setting
7883
``extra_time`` to S seconds effectively allows a contestant to use S
7984
seconds more than before (regardless of the time she started the
8085
contest).
8186

8287
Again, delay time is similar, but it shifts both contestant and
83-
contest time-window by that value. The effect on available time
88+
contest time window by that value. The effect on available time
8489
similar to that achieved by setting ``extra_time``, with the
8590
difference explained before in point 1. Also, there is a difference in
86-
token generation as explained in point 2. before.
91+
token generation as explained in point 2 above.
8792

8893
Finally, changing ``starting_time`` is very similar to changing
89-
``delay_time``, but it shifts just the contestant time-window, hence
94+
``delay_time``, but it shifts just the contestant time window, hence
9095
if that window was already going over ``end_time``, at all effects
9196
advancing ``starting_time`` would not award more time to the
9297
contestant, because the end would still be capped at ``end_time``. The

0 commit comments

Comments
 (0)