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

Fix some docs and comments

Browse Source
This commit is contained in:
Chris de Graaf 2019-09-24 15:37:06 +07:00
parent d53fb0b119
commit a941b96e1d
No known key found for this signature in database
GPG Key ID: 150FFDD9B0073C7B
3 changed files with 1 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/plugins/git.jl
View File

@ -6,9 +6,9 @@ Creates a Git repository and a `.gitignore` file.
## Keyword Arguments ## Keyword Arguments
- `ignore::Vector{<:AbstractString}`: Patterns to add to the `.gitignore`. - `ignore::Vector{<:AbstractString}`: Patterns to add to the `.gitignore`.
See also: [`gitignore`](@ref). See also: [`gitignore`](@ref).
- `manifest::Bool`: Whether or not to commit `Manifest.toml`.
- `ssh::Bool`: Whether or not to use SSH for the remote. - `ssh::Bool`: Whether or not to use SSH for the remote.
If left unset, HTTPS is used. If left unset, HTTPS is used.
- `manifest::Bool`: Whether or not to commit `Manifest.toml`.
- `gpgsign::Bool`: Whether or not to sign commits with your GPG key. - `gpgsign::Bool`: Whether or not to sign commits with your GPG key.
This option requires that the Git CLI is installed. This option requires that the Git CLI is installed.
""" """

1
src/template.jl
View File

@ -28,7 +28,6 @@ A configuration used to generate packages.
- `dir::AbstractString="$(contractuser(Pkg.devdir()))"`: Directory to place packages in. - `dir::AbstractString="$(contractuser(Pkg.devdir()))"`: Directory to place packages in.
- `host::AbstractString="github.com"`: URL to the code hosting service where packages will reside. - `host::AbstractString="github.com"`: URL to the code hosting service where packages will reside.
- `julia_version::VersionNumber=$(repr(default_version()))`: Minimum allowed Julia version. - `julia_version::VersionNumber=$(repr(default_version()))`: Minimum allowed Julia version.
- `develop::Bool=true`: Whether or not to `develop` new packages in the active environment.
### Template Plugins ### Template Plugins
- `plugins::Vector{<:Plugin}=Plugin[]`: A list of [`Plugin`](@ref)s used by the template. - `plugins::Vector{<:Plugin}=Plugin[]`: A list of [`Plugin`](@ref)s used by the template.

2
test/reference.jl
View File

@ -1,5 +1,3 @@
# TODO: License fixtures need to be updated every year because they don't use Mustache.
function PT.user_view(::Citation, ::Template, ::AbstractString) function PT.user_view(::Citation, ::Template, ::AbstractString)
return Dict("MONTH" => 8, "YEAR" => 2019) return Dict("MONTH" => 8, "YEAR" => 2019)
end end