Skip to content
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Contest_API.md
Original file line number Diff line number Diff line change
Expand Up @@ -1820,6 +1820,9 @@ Properties of clarification message objects:

The recipients of a clarification are the union of `to_team_ids` and `to_group_ids`. A clarification is sent to all teams if `from_team_id`, `to_team_ids` and `to_group_ids` are null. Note that if `from_team_id` is not `null`, then both `to_team_ids` and `to_group_ids` must be `null`. That is, teams cannot send messages to other teams or groups.

Clarifications between a team and the jury are typically private. If the jury sends a response to others than just the original team, then the
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence sounds awkward. Maybe something like: If the jury replies to the clarification and chooses to include additional recipients (teams?) or everyone, then the 'reply_to_id' should be removed...

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reworded and reordered the sentence, please take another look.

`reply_to_id` should be removed for everyone who couldn't see the original message in order to preserve referential integrity.

#### Modifying clarifications

To add a clarification, clients can use the `POST` method on the clarifications endpoint or the
Expand Down
5 changes: 4 additions & 1 deletion Contest_Control_System_Requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -640,7 +640,10 @@ following operations:
- Determine, for any specific clarification request, what answer was returned to
the team if the clar has already been answered.
- Compose an answer to the clar and send it, along with the text of the original
clarification request, to the team.
clarification request, to the team. The best practice is to include the
original clarification text as an internet-style response, which allows the judge
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we all know what "internet-style" means here, but is it really clear? I don't know of this ever being called this.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, maybe we should specifically say what we mean here? I.e. something like "add the original question in its entirety, prepending every line by > ". Normally I would worry about over-specifying, but this is just a "the best practice is", so I think it would be fine, and it would certainly be more clear than "internet-style".

What do y'all think?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fair enough, reworded giving this explanation. Left a reference to 'internet style quoting' in because that seems to be the common name for it and gives something to google if the reader doesn't fully understand it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, now I feel a bit dumb, I never actually searched for "internet style quoting". It seems to indeed mean exactly what you used it for, I had just never heard it I guess. My mistake.

to respond to multiple points or edit it, and doesn't require the original
clarification text to understand the response.
- Optionally choose to also send the clarification request text and answer to
all teams in the contest.
- Change the category of a clarification request.
Expand Down