Browse Source

Clarify return values.

Clarify that Literate.markdown, Literate.script, and Literate.notebook return the path of the generated file.
pull/277/head
Adam Wheeler 4 months ago
parent
commit
42fa44c73c
  1. 4
      src/Literate.jl

4
src/Literate.jl

@ -566,6 +566,7 @@ end @@ -566,6 +566,7 @@ end
Literate.script(inputfile, outputdir=pwd(); config::AbstractDict=Dict(), kwargs...)
Generate a plain script file from `inputfile` and write the result to `outputdir`.
Returns the path to the generated file.
See the manual section on [Configuration](@ref) for documentation
of possible configuration with `config` and other keyword arguments.
@ -605,7 +606,7 @@ end @@ -605,7 +606,7 @@ end
Literate.markdown(inputfile, outputdir=pwd(); config::AbstractDict=Dict(), kwargs...)
Generate a markdown file from `inputfile` and write the result
to the directory `outputdir`.
to the directory `outputdir`. Returns the path to the generated file.
See the manual section on [Configuration](@ref) for documentation
of possible configuration with `config` and other keyword arguments.
@ -742,6 +743,7 @@ line_is_nbmeta(line) = startswith(line, "%% ") @@ -742,6 +743,7 @@ line_is_nbmeta(line) = startswith(line, "%% ")
Literate.notebook(inputfile, outputdir=pwd(); config::AbstractDict=Dict(), kwargs...)
Generate a notebook from `inputfile` and write the result to `outputdir`.
Returns the path to the generated file.
See the manual section on [Configuration](@ref) for documentation
of possible configuration with `config` and other keyword arguments.

Loading…
Cancel
Save