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

Tweak docs

Browse Source
This commit is contained in:
Chris de Graaf 2019-09-20 01:14:57 +07:00
parent 2a5fb5ccc8
commit 980452fde3
No known key found for this signature in database
GPG Key ID: 150FFDD9B0073C7B
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/developer.md
View File

@ -93,8 +93,12 @@ view
Finally, we implement [`hook`](@ref), which is the real workhorse for the plugin. Finally, we implement [`hook`](@ref), which is the real workhorse for the plugin.
TODO prehook and posthook in examples
```@docs ```@docs
prehook
hook hook
posthook
``` ```
Inside of this function, we call a few more functions, which help us with text templating. Inside of this function, we call a few more functions, which help us with text templating.
@ -107,7 +111,7 @@ combined_view
tags tags
``` ```
todo more TODO more
## `BasicPlugin` Walkthrough ## `BasicPlugin` Walkthrough

8
src/plugin.jl
View File

@ -63,7 +63,7 @@ tags(::Plugin) = "{{", "}}"
gitignore(::Plugin) -> Vector{String} gitignore(::Plugin) -> Vector{String}
Return patterns that should be added to `.gitignore`. 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. By default, an empty list is returned.
""" """
@ -128,6 +128,10 @@ end
Do some work associated with a plugin **before** any files are generated. 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. 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 prehook(::Plugin, ::Template, ::AbstractString) = nothing
@ -140,7 +144,7 @@ end
""" """
posthook(::Plugin, ::Template, pkg_dir::AbstractString) 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 posthook(::Plugin, ::Template, ::AbstractString) = nothing