diff --git a/docs/src/developer.md b/docs/src/developer.md index 7e07456..87853ed 100644 --- a/docs/src/developer.md +++ b/docs/src/developer.md @@ -93,8 +93,12 @@ view Finally, we implement [`hook`](@ref), which is the real workhorse for the plugin. +TODO prehook and posthook in examples + ```@docs +prehook hook +posthook ``` Inside of this function, we call a few more functions, which help us with text templating. @@ -107,7 +111,7 @@ combined_view tags ``` -todo more +TODO more ## `BasicPlugin` Walkthrough diff --git a/src/plugin.jl b/src/plugin.jl index 9bb7f22..06ba827 100644 --- a/src/plugin.jl +++ b/src/plugin.jl @@ -63,7 +63,7 @@ tags(::Plugin) = "{{", "}}" gitignore(::Plugin) -> Vector{String} Return patterns that should be added to `.gitignore`. -These are used by the [`Gitignore`](@ref) plugin. +These are used by the [`Git`](@ref) plugin. By default, an empty list is returned. """ @@ -128,6 +128,10 @@ end Do some work associated with a plugin **before** any files are generated. At this point, `pkg_dir` is an empty directory that will eventually contain the package. + +!!! note + `pkg_dir` only stays empty until the first plugin chooses to create a file. + Don't count on the order in which the plugins are sorted! """ prehook(::Plugin, ::Template, ::AbstractString) = nothing @@ -140,7 +144,7 @@ end """ posthook(::Plugin, ::Template, pkg_dir::AbstractString) -Do some work associated with a plugin **after** after files have been generated. +Do some work associated with a plugin **after** files have been generated. """ posthook(::Plugin, ::Template, ::AbstractString) = nothing