From 42fa44c73c07705909e012a9b06789210cc42af3 Mon Sep 17 00:00:00 2001 From: Adam Wheeler Date: Thu, 7 Aug 2025 11:41:22 -0400 Subject: [PATCH] Clarify return values. Clarify that Literate.markdown, Literate.script, and Literate.notebook return the path of the generated file. --- src/Literate.jl | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/Literate.jl b/src/Literate.jl index 2e381fc..f942e7f 100644 --- a/src/Literate.jl +++ b/src/Literate.jl @@ -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 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, "%% ") 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.