Fix some docs

This commit is contained in:
Chris de Graaf 2020-02-15 20:44:55 +07:00
parent 914480157b
commit abbfdb00ea
No known key found for this signature in database
GPG Key ID: 150FFDD9B0073C7B
2 changed files with 4 additions and 2 deletions

View File

@ -76,8 +76,8 @@ To understand how they're implemented, let's look at simplified versions of two
```julia
@with_kw_noshow struct Documenter <: Plugin
make_jl::String = default_file("docs", "make.jl") <- "Path to make.jl template"
index_md::String = default_file("docs", "src", "index.md") <- "Path to index.md template"
make_jl::String = default_file("docs", "make.jl")
index_md::String = default_file("docs", "src", "index.md")
end
gitignore(::Documenter) = ["/docs/build/"]

View File

@ -1,5 +1,6 @@
"""
TagBot(;
file="$(contractuser(default_file("github", "workflows", "TagBot.yml")))",
destination="TagBot.yml",
cron="0 * * * *",
token=Secret("GITHUB_TOKEN"),
@ -18,6 +19,7 @@
Adds GitHub release support via [TagBot](https://github.com/JuliaRegistries/TagBot).
## Keyword Arguments
- `file::AbstractString`: Template file for the workflow file.
- `destination::AbstractString`: Destination of the workflow file, relative to `.github/workflows`.
- `cron::AbstractString`: Cron expression for the schedule interval.
- `token::Secret`: Name of the token secret to use.