TastyPancakes/PkgTemplates.jl
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix up some docstrings

Browse Source
This commit is contained in:
Chris de Graaf 2017-08-25 01:25:26 -05:00
parent bc36fba22a
commit 9f4cb1d522
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/licenses.jl
View File

@ -11,7 +11,7 @@ const LICENSES = Dict(
) )
""" """
available_licenses([io]) -> Void available_licenses([io::IO]) -> Void
Print the names of all available licenses. Print the names of all available licenses.
""" """
@ -27,10 +27,10 @@ show_license(io::IO, license::AbstractString) = println(io, read_license(license
show_license(license::AbstractString) = show_license(STDOUT, license) show_license(license::AbstractString) = show_license(STDOUT, license)
""" """
read_license(licence::AbstractString) -> String read_license(license::AbstractString) -> String
Returns the contents of `license`. Errors if it is not found. Use [`show_license`](@ref) to Returns the contents of `license`. Errors if it is not found. Use
view available licenses. [`available_licenses`](@ref) to view available licenses.
""" """
function read_license(license::AbstractString) function read_license(license::AbstractString)
path = joinpath(LICENSE_DIR, license) path = joinpath(LICENSE_DIR, license)

2
src/template.jl
View File

@ -110,7 +110,7 @@ create a template, you can use [`interactive_template`](@ref) instead.
end end
""" """
interactive_template(; fast::Bool) -> Template interactive_template(; fast::Bool=false) -> Template
Interactively create a [`Template`](@ref). If `fast` is set, defaults will be assumed for Interactively create a [`Template`](@ref). If `fast` is set, defaults will be assumed for
all values except username and plugins. all values except username and plugins.