From 82e27580c969e06bb6f157aa8d447ca9f56eef62 Mon Sep 17 00:00:00 2001 From: Vaverka <47707103+jvaverka@users.noreply.github.com> Date: Tue, 6 Jul 2021 11:31:19 -0400 Subject: [PATCH] [doc] fix some typos in documentation (#154) --- docs/src/customprocessing.md | 2 +- docs/src/fileformat.md | 4 ++-- docs/src/index.md | 4 ++-- docs/src/outputformats.md | 6 +++--- docs/src/tips.md | 2 +- examples/example.jl | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/src/customprocessing.md b/docs/src/customprocessing.md index 7fd6924..c2e8f3d 100644 --- a/docs/src/customprocessing.md +++ b/docs/src/customprocessing.md @@ -10,7 +10,7 @@ is done by letting the user supply custom pre- and post-processing functions that may do transformation of the content. All of the generators ([`Literate.markdown`](@ref), [`Literate.notebook`](@ref) -and [`Literate.script`](@ref)) accepts `preprocess` and `postprocess` keyword +and [`Literate.script`](@ref)) accept `preprocess` and `postprocess` keyword arguments. The default "transformation" is the `identity` function. The input to the transformation functions is a `String`, and the output should be the transformed `String`. diff --git a/docs/src/fileformat.md b/docs/src/fileformat.md index d9eefa4..481f679 100644 --- a/docs/src/fileformat.md +++ b/docs/src/fileformat.md @@ -12,7 +12,7 @@ The basic syntax is simple: - all other lines are treated as julia code. Leading whitespace is allowed before `#`, but it will be removed when generating the -output. Since `#`-lines is treated as markdown we can not use that for regular julia +output. Since `#`-lines are treated as markdown we can not use that for regular julia comments, for this you can instead use `## `, which will render as `# ` in the output. Lets look at a simple example: @@ -113,7 +113,7 @@ is a case where we can prepend `#md` to those lines: #md # ``` ```` The lines in the example above would be filtered out in the preprocessing step, unless we are -generating a markdown file. When generating a markdown file we would simple remove +generating a markdown file. When generating a markdown file we would simply remove the leading `#md ` from the lines. Beware that the space after the tag is also removed. The `#src` token can also be placed at the *end* of a line. This is to make it possible diff --git a/docs/src/index.md b/docs/src/index.md index 58771eb..f9f3761 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -29,8 +29,8 @@ Examples are (probably) the best way to showcase your awesome package, and examp are often the best way for a new user to learn how to use it. It is therefore important that the documentation of your package contains examples for users to read and study. However, people are different, and we all prefer different ways of trying out a new -package. Some people wants to RTFM, others want to explore the package interactively in, -for example, a notebook, and some people wants to study the source code. The aim of +package. Some people want to RTFM, others want to explore the package interactively in, +for example, a notebook, and some people want to study the source code. The aim of Literate is to make it easy to give the user all of these options, while still keeping maintenance to a minimum. diff --git a/docs/src/outputformats.md b/docs/src/outputformats.md index 939b861..9bd73b8 100644 --- a/docs/src/outputformats.md +++ b/docs/src/outputformats.md @@ -1,6 +1,6 @@ # [**4.** Output Formats](@id Output-Formats) -When the source is parsed, and have been processed it is time to render the output. +When the source is parsed, and has been processed it is time to render the output. We will consider the following source snippet: ```@eval @@ -143,10 +143,10 @@ keyword arguments. Passing configuration as a dictionary requires at least Literate version 2.2. !!! note "Configuration precedence" - Individual keyword arguments takes precedence over the `config` dictionary, so for e.g. + Individual keyword arguments take precedence over the `config` dictionary, so for e.g. `Literate.markdown(...; config = Dict("name" => "hello"), name = "world")` the resulting configuration for `name` will be `"world"`. Both individual keyword arguments - and the `config` dictionary takes precedence over the default. + and the `config` dictionary take precedence over the default. Available configurations with description and default values are given in the reference for [`Literate.DEFAULT_CONFIGURATION`](@ref) just below. diff --git a/docs/src/tips.md b/docs/src/tips.md index 83201d7..e9bde80 100644 --- a/docs/src/tips.md +++ b/docs/src/tips.md @@ -19,7 +19,7 @@ the generated notebook can become large. In order to remedy this you can use the clever Julia package [`DisplayAs`](https://github.com/tkf/DisplayAs.jl) to limit the output capabilities of -and object. For example, to "force" an image to be captures as `image/png` only, +an object. For example, to "force" an image to be captures as `image/png` only, you can use ```julia diff --git a/examples/example.jl b/examples/example.jl index 70ede00..9c5a5a5 100644 --- a/examples/example.jl +++ b/examples/example.jl @@ -8,7 +8,7 @@ # This is an example generated with Literate based on this # source file: [`example.jl`](@__REPO_ROOT_URL__/examples/example.jl). # You are seeing the -#md # HTML-output which Documenter have generated based on a markdown +#md # HTML-output which Documenter has generated based on a markdown #md # file generated with Literate. The corresponding notebook #md # can be viewed in [nbviewer](http://nbviewer.jupyter.org/) here: #md # [`example.ipynb`](@__NBVIEWER_ROOT_URL__/generated/example.ipynb),