Skip to content

Commit

Permalink
Added docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ffevotte committed May 19, 2020
1 parent 9233aa9 commit 2fadde7
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions src/Revise.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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()

"""
Expand All @@ -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}()

"""
Expand Down Expand Up @@ -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, "")

"""
Expand Down

0 comments on commit 2fadde7

Please sign in to comment.