Tweak some docs

docs/src/developer.md

@@ -25,7 +25,8 @@ The [`Template`](@ref) constructor basically does this:
 ```
 - extract values from keyword arguments
 - create a Template from the values
-- validate each plugin against the constructed Template
+- for each plugin:
+  - validate plugin against the template
 ```
 
 The plugin validation step uses the [`validate`](@ref) function.

docs/src/migrating.md

@@ -59,7 +59,6 @@ Although it's unlikely that anyone used these.
 | :------------------: | :--------------------------------------------------------------------------------------------------: |
 | `available_licenses` | [View licenses on GitHub](https://github.com/invenia/PkgTemplates.jl/tree/master/templates/licenses) |
 | `show_license`       | [View licenses on GitHub](https://github.com/invenia/PkgTemplates.jl/tree/master/templates/licenses) |
-|                      |                                                                                                      |
 
 ## Custom Plugins
 

src/plugins/git.jl

@@ -10,7 +10,7 @@ Creates a Git repository and a `.gitignore` file.
   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.
-  This option requires that the Git CLI is installed.
+  This option requires that the Git CLI is installed, and for you to have a GPG key associated with your committer identity.
 """
 @with_kw_noshow struct Git <: Plugin
     ignore::Vector{String} = []

src/plugins/src_dir.jl

@@ -2,6 +2,9 @@
     SrcDir(; file="$(contractuser(default_file("src", "module.jl")))")
 
 Creates a module entrypoint.
+
+## Keyword Arguments
+- `file::AbstractString`: Template file for `src/<module>.jl`.
 """
 @with_kw_noshow mutable struct SrcDir <: BasicPlugin
     file::String = default_file("src", "module.jl")

src/plugins/tests.jl

@@ -7,7 +7,7 @@ const TEST_DEP = PackageSpec(; name="Test", uuid=TEST_UUID)
 Sets up testing for packages.
 
 ## Keyword Arguments
-- `file::AbstractString`: Template file for the `runtests.jl`.
+- `file::AbstractString`: Template file for `runtests.jl`.
 - `project::Bool`: Whether or not to create a new project for tests (`test/Project.toml`).
   See [here](https://julialang.github.io/Pkg.jl/v1/creating-packages/#Test-specific-dependencies-in-Julia-1.2-and-above-1) for more details.
 
@@ -27,7 +27,7 @@ function validate(p::Tests, t::Template)
     invoke(validate, Tuple{BasicPlugin, Template}, p, t)
     p.project && t.julia < v"1.2" && @warn string(
         "Tests: The project option is set to create a project (supported in Julia 1.2 and later) ",
-        "but a Julia version older than 1.2 is supported by the Template.",
+        "but a Julia version older than 1.2 is supported by the Template",
     )
 end