From 3a2ce9ee46d8786d42268503c3d34a458831e81d Mon Sep 17 00:00:00 2001 From: Chris de Graaf Date: Mon, 21 Aug 2017 14:52:50 -0500 Subject: [PATCH] Update docs slightly --- README.md | 4 ++-- docs/src/index.md | 4 ++-- src/generate.jl | 6 +----- 3 files changed, 5 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 6fccb75..cef2a3c 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ julia> t = Template(; license="MIT", authors=["Chris de Graaf", "Invenia Technical Computing Corporation"], years="2016-2017", - dir=joinpath(ENV["HOME"], "code"), + dir=joinpath(homedir(), "code"), julia_version=v"0.5.2", requirements=["PkgTemplates"], git_config=Dict("diff.renames" => true), @@ -60,7 +60,7 @@ julia> t = Template(; CodeCov(; config_file=nothing), Coveralls(), AppVeyor(), - GitHubPages(; assets=[joinpath(ENV["HOME"], "invenia.css")]), + GitHubPages(; assets=[joinpath(homedir(), "invenia.css")]), ], ) diff --git a/docs/src/index.md b/docs/src/index.md index 0d3d2d1..bdd1184 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -37,7 +37,7 @@ t = Template(; license="MIT", authors=["Chris de Graaf", "Invenia Technical Computing Corporation"], years="2016-2017", - dir=joinpath(ENV["HOME"], "code"), + dir=joinpath(homedir(), "code"), julia_version=v"0.5.2", requirements=["PkgTemplates"], git_config=Dict("diff.renames" => true), @@ -46,7 +46,7 @@ t = Template(; CodeCov(; config_file=nothing), Coveralls(), AppVeyor(), - GitHubPages(; assets=[joinpath(ENV["HOME"], "invenia.css")]), + GitHubPages(; assets=[joinpath(homedir(), "invenia.css")]), ], ) generate("MyPkg", t; force=true, ssh=true) diff --git a/src/generate.jl b/src/generate.jl index fb1b5a5..f2bac2a 100644 --- a/src/generate.jl +++ b/src/generate.jl @@ -6,11 +6,7 @@ ssh::Bool=false, ) -> Void -Generate a package from a template. - -# Arguments -* `pkg_name::AbstractString`: Name of the package (with or without trailing ".jl"). -* `t::Template`: The template from which to generate the package. +Generate a package names `pkg_name` from `template`. # Keyword Arguments * `force::Bool=false`: Whether or not to overwrite old packages with the same name.