From 2fadde7315b8959604a97a12e507e81c62cf4285 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Fran=C3=A7ois=20F=C3=A9votte?=
 <francois.fevotte@triscale-innov.com>
Date: Wed, 20 May 2020 00:00:21 +0200
Subject: [PATCH] Added docstrings

---
 src/Revise.jl | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/src/Revise.jl b/src/Revise.jl
index a85b30f1..cf773585 100644
--- a/src/Revise.jl
+++ b/src/Revise.jl
@@ -94,6 +94,11 @@ This list gets populated by callbacks that watch directories for updates.
 """
 const revision_queue = Set{Tuple{PkgData,String}}()
 
+"""
+    Revise.revision_event
+
+This `Condition` is used to notify `entr` that one of the watched files has changed.
+"""
 const revision_event = Condition()
 
 """
@@ -104,7 +109,19 @@ file has changed but the user hooks have not yet been called.
 """
 const user_callbacks_queue = Set{Any}()
 
+"""
+    Revise.user_callbacks_by_file
+
+Global variable, maps files (identified by their absolute path) to the set of
+callback keys registered for them.
+"""
 const user_callbacks_by_file = Dict{String, Set{Any}}()
+
+"""
+    Revise.user_callbacks_by_key
+
+Global variable, maps callback keys to user hooks.
+"""
 const user_callbacks_by_key = Dict{Any, Any}()
 
 """
@@ -196,6 +213,13 @@ Global variable, maps `(pkgdata, filename)` pairs that errored upon last revisio
 """
 const queue_errors = Dict{Tuple{PkgData,String},Tuple{Exception, Any}}()
 
+"""
+    Revise.NOPACKAGE
+
+Global variable; default `PkgId` used for files which do not belong to any
+package, but still have to be watched because user callbacks have been
+registered for them.
+"""
 const NOPACKAGE = PkgId(nothing, "")
 
 """