summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJacob Schatz <jschatz1@gmail.com>2017-03-16 10:19:49 -0400
committerJacob Schatz <jschatz1@gmail.com>2017-03-16 10:19:49 -0400
commit477b5e838d1424930eec9dc25ba989f84d4fdbb8 (patch)
treec173aae91e7d79cd40def8f63bdd2b1edcc8de9d
parent209b0d442cb9b3722de1c3a7693b3bb809255514 (diff)
downloadgitlab-ce-realtime-methods-docs.tar.gz
Fix spelling and grammatical errors.realtime-methods-docs
-rw-r--r--doc/development/frontend.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/development/frontend.md b/doc/development/frontend.md
index db00a603aa5..766b5f1f477 100644
--- a/doc/development/frontend.md
+++ b/doc/development/frontend.md
@@ -40,7 +40,7 @@ When writing code for realtime features we have to keep a couple of things in mi
Thus, we must strike a balance between sending requests and the feeling of realtime. Use the following rules when creating realtime solutions.
-1. The server will tell you how much to poll by sending `X-Poll-Interval` in the header. Use that as your polling interval. This way it is easy for system administrators to change the polling rate. A `X-Poll-Interval: -1` means disabled polling, and this must be implemented.
+1. The server will tell you how much to poll by sending `X-Poll-Interval` in the header. Use that as your polling interval. This way it is easy for system administrators to change the polling rate. A `X-Poll-Interval: -1` means you should disable polling, and this must be implemented.
1. A response of `HTTP 429 Too Many Requests`, should disable polling as well. This must also be implemented.
1. Use a common library for polling.
1. Poll on active tabs only. Use a common library to find out which tab currently has eyes on it. Please use [Focus](https://gitlab.com/andrewn/focus). Specifically [Eyeballs Detector](https://gitlab.com/andrewn/focus/blob/master/lib/eyeballs-detector.js).