Browse Source

Very minor docstring fixes (#78)

pull/75/head
Thibaut Lienart 6 years ago committed by Fredrik Ekre
parent
commit
bd11c9d682
  1. 4
      src/Literate.jl

4
src/Literate.jl

@ -318,14 +318,14 @@ Generate a markdown file from `inputfile` and write the result
to the directory `outputdir`. to the directory `outputdir`.
Keyword arguments: Keyword arguments:
- `name`: name of the output file, excluding `.md`. `name` is also used to name - `name`: name of the output file, excluding `.md`; `name` is also used to name
all the `@example` blocks, and to replace `@__NAME__`. all the `@example` blocks, and to replace `@__NAME__`.
Defaults to the filename of `inputfile`. Defaults to the filename of `inputfile`.
- `preprocess`, `postprocess`: custom pre- and post-processing functions, - `preprocess`, `postprocess`: custom pre- and post-processing functions,
see the [Custom pre- and post-processing](@ref Custom-pre-and-post-processing) see the [Custom pre- and post-processing](@ref Custom-pre-and-post-processing)
section of the manual. Defaults to `identity`. section of the manual. Defaults to `identity`.
- `documenter`: boolean that tells if the output is intended to use with Documenter.jl. - `documenter`: boolean that tells if the output is intended to use with Documenter.jl.
Defaults to `true`. See the the manual section on Defaults to `true`. See the manual section on
[Interaction with Documenter](@ref Interaction-with-Documenter). [Interaction with Documenter](@ref Interaction-with-Documenter).
- `codefence`: A `Pair` of opening and closing code fence. Defaults to - `codefence`: A `Pair` of opening and closing code fence. Defaults to
```` ````

Loading…
Cancel
Save