modify docs

goropikari · Feb 25, 2018 · 4c8b0d0 · 4c8b0d0
1 parent 9c45f7b
commit 4c8b0d0
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/src/linux.jl b/src/linux.jl
@@ -27,18 +27,18 @@ function notify(message::AbstractString;
 end
 
 @doc """
-    alarm(;sound::AbstractString)
-    notify by sound
+Notifier.alarm(;sound::AbstractString)
+notify by sound
 
-    if you choose a specific sound WAV file, you can use it instead of the defalut sound.
+if you choose a specific sound WAV file, you can use it instead of the defalut sound.
 """ alarm
 function alarm(;sound::AbstractString=joinpath(@__DIR__, "default.wav"))
     @async run(`aplay -q $sound`)
     return nothing
 end
 
 @doc """
-register_email()
+Notifier.register_email()
 
 register a recipient e-mail address
 """ register_email
@@ -68,7 +68,7 @@ function register_email()
 end
 
 @doc """
-email(message; subject, To)
+Notifier.email(message; subject, To)
 
 defalut\n
 subject="\$(round(now(), Dates.Second(1)))"\n

diff --git a/src/windows.jl b/src/windows.jl
@@ -3,7 +3,7 @@ export notify, alarm
 
 @doc """
 ---
-notify(message::AbstractString;
+Notifier.notify(message::AbstractString;
        title::AbstractString,
        sound::Union{Bool, AbstractString},
        time::Real)
@@ -30,9 +30,9 @@ function notify(message::AbstractString;
 end
 
 @doc """
-    alarm(;sound::AbstractString)
-    notify by sound
+Notifier.alarm(;sound::AbstractString)
+notify by sound
 
-    if you choose a specific sound WAV file, you can use it instead of the default sound.
+if you choose a specific sound WAV file, you can use it instead of the default sound.
 """ alarm
 alarm(;sound::AbstractString=joinpath(@__DIR__, "default.wav")) = @async run(`powershell -Command '('new-object System.Media.SoundPlayer $sound')'.PlaySync'('')'`)