Skip to content

Commit

Permalink
Fix various typos (JuliaDocs#2088)
Browse files Browse the repository at this point in the history
  • Loading branch information
goggle authored Mar 27, 2023
1 parent 791b3ec commit 329bff0
Show file tree
Hide file tree
Showing 14 changed files with 21 additions and 21 deletions.
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

* Fix a rare logger error for failed doctests. (#1698), (#1699)

* Fix an error occuring with `DocTestFilters = nothing` in `@meta` blocks. (#1696)
* Fix an error occurring with `DocTestFilters = nothing` in `@meta` blocks. (#1696)

## Version v0.27.6 - 2021-09-07

Expand Down Expand Up @@ -489,7 +489,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

* Type aliases of `Union`s (e.g. `const MyAlias = Union{Foo,Bar}`) are now correctly listed as "Type" in docstrings. (#1466), (#1474)

* HTMLWriter no longers prints a warning when encountering `mailto:` URLs in links. (#1472)
* HTMLWriter no longer prints a warning when encountering `mailto:` URLs in links. (#1472)

## Version v0.25.3 - 2020-10-28

Expand Down Expand Up @@ -573,7 +573,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

* The LaTeX/PDF backend now supports the `platform="none"` keyword, which outputs only the TeX source files, rather than a compiled PDF. (#1338), (#1339)

* Linkcheck no longer prints a warning when enountering a `302 Found` temporary redirect. (#1344), (#1345)
* Linkcheck no longer prints a warning when encountering a `302 Found` temporary redirect. (#1344), (#1345)

### Fixed

Expand Down Expand Up @@ -1092,4 +1092,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

* The at-blocks that execute code can now handle `include` statements. (#793), (#794)

* At-docs blocks no longer give an error when containing empty lines. (#823), (#824)
* At-docs blocks no longer give an error when containing empty lines. (#823), (#824)
2 changes: 1 addition & 1 deletion assets/html/scss/bulma/utilities/mixins.sass
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@
top: calc(50% + 4px)
&:hover
background-color: bulmaRgba(black, 0.05)
// Modifers
// Modifiers
&.is-active
span
&:nth-child(1)
Expand Down
2 changes: 1 addition & 1 deletion assets/html/themeswap.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Small function to quickly swap out themes. Gets put into the <head> tag..
function set_theme_from_local_storage() {
// Intialize the theme to null, which means default
// Initialize the theme to null, which means default
var theme = null;
// If the browser supports the localstorage and is not disabled then try to get the
// documenter theme
Expand Down
4 changes: 2 additions & 2 deletions docs/src/man/syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -723,7 +723,7 @@ using the `@raw` block.

````markdown
```@raw html
<svg style="display: block; margin: 0 auto;" width="5em" heigth="5em">
<svg style="display: block; margin: 0 auto;" width="5em" height="5em">
<circle cx="2.5em" cy="2.5em" r="2em" stroke="black" stroke-width=".1em" fill="red" />
</svg>
```
Expand All @@ -732,7 +732,7 @@ using the `@raw` block.
It will show up as follows, with code having been copied over verbatim to the HTML file.

```@raw html
<svg style="display: block; margin: 0 auto;" width="5em" heigth="5em">
<svg style="display: block; margin: 0 auto;" width="5em" height="5em">
<circle cx="2.5em" cy="2.5em" r="2em" stroke="black" stroke-width=".1em" fill="red" />
(SVG)
</svg>
Expand Down
2 changes: 1 addition & 1 deletion docs/src/showcase.md
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ println("Hello World")
### Color output

Output from [`@repl` block](@ref)s and [`@example` block](@ref)s support colored output,
tranforming ANSI color codes to HTML.
transforming ANSI color codes to HTML.

!!! compat "Julia 1.6"
Color output requires Julia 1.6 or higher.
Expand Down
2 changes: 1 addition & 1 deletion src/CrossReferences.jl
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ function xref(node::MarkdownAST.Node, meta, page, doc)
basicxref(node, meta, page, doc)
return false
end
# If `slug` is a string referncing a known header, we'll go for that
# If `slug` is a string referencing a known header, we'll go for that
if Anchors.exists(doc.internal.headers, slug)
namedxref(node, slug, meta, page, doc)
return false
Expand Down
2 changes: 1 addition & 1 deletion src/Expanders.jl
Original file line number Diff line number Diff line change
Expand Up @@ -701,7 +701,7 @@ function Selectors.runner(::Type{ExampleBlocks}, node, page, doc)
# Evaluate the code block. We redirect stdout/stderr to `buffer`.
result, buffer = nothing, IOBuffer()
if !continued # run the code
# check if there is any code wating
# check if there is any code waiting
if haskey(page.globals.meta, :ContinuedCode) && haskey(page.globals.meta[:ContinuedCode], sym)
code = page.globals.meta[:ContinuedCode][sym] * '\n' * x.code
delete!(page.globals.meta[:ContinuedCode], sym)
Expand Down
2 changes: 1 addition & 1 deletion src/documents.jl
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ function Base.show(io::IO, n::NavNode)
end

"""
Constructs a list of the ancestors of the `navnode` (inclding the `navnode` itself),
Constructs a list of the ancestors of the `navnode` (including the `navnode` itself),
ordered so that the root of the navigation tree is the first and `navnode` itself
is the last item.
"""
Expand Down
2 changes: 1 addition & 1 deletion src/html/HTMLWriter.jl
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ import ANSIColoredPrinters

export HTML

"Data attribute for the script inserting a wraning for outdated docs."
"Data attribute for the script inserting a warning for outdated docs."
const OUTDATED_VERSION_ATTR = "data-outdated-warner"

"List of Documenter native themes."
Expand Down
2 changes: 1 addition & 1 deletion test/doctests/doctests.jl
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ rfile(filename) = joinpath(@__DIR__, "stdouts", filename)
end
end

# Tests for doctest = :only. The outout should reflect that the docs themselves do not
# Tests for doctest = :only. The output should reflect that the docs themselves do not
# get built.
run_makedocs(["working.md"]; modules=[FooWorking], doctest = :only) do result, success, backtrace, output
@test success
Expand Down
6 changes: 3 additions & 3 deletions test/errors/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ parse error
```

```@meta
CurrentModule = NonExistantModule
CurrentModule = NonExistentModule
```

```@autodocs
Modules = [NonExistantModule]
Modules = [NonExistentModule]
```

```@eval
NonExistantModule
NonExistentModule
```

```@docs
Expand Down
2 changes: 1 addition & 1 deletion test/examples/references/latex_showcase.tex
Original file line number Diff line number Diff line change
Expand Up @@ -907,7 +907,7 @@ \subsection{Color output}
\label{17347250707405175741}{}
Output from \hyperlinkref{16839343392674353047}{\texttt{@repl} block}s and \hyperlinkref{12317204655950454097}{\texttt{@example} block}s support colored output, tranforming ANSI color codes to HTML.
Output from \hyperlinkref{16839343392674353047}{\texttt{@repl} block}s and \hyperlinkref{12317204655950454097}{\texttt{@example} block}s support colored output, transforming ANSI color codes to HTML.
Expand Down
2 changes: 1 addition & 1 deletion test/examples/src.latex_showcase/showcase.md
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ x + 1
### Color output

Output from [`@repl` block](@ref)s and [`@example` block](@ref)s support colored output,
tranforming ANSI color codes to HTML.
transforming ANSI color codes to HTML.

#### Colored `@repl` block output

Expand Down
4 changes: 2 additions & 2 deletions test/examples/src/man/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ _Note: we can't define the `show` method in the `@example` block due to the worl
counter in Julia 0.6 (Documenter's `makedocs` is not aware of any of the new method
definitions happening in `eval`s)._

We can also show SVG images with interactivity via the `text/html` MIME to display output that combines HTML, JS and CSS. Assume the following type and method live in the `InlineHTML` modeul
We can also show SVG images with interactivity via the `text/html` MIME to display output that combines HTML, JS and CSS. Assume the following type and method live in the `InlineHTML` module

```julia
struct HTML
Expand Down Expand Up @@ -402,7 +402,7 @@ end

![Julia circles](julia.svg)

Dowload [`data.csv`](data.csv).
Download [`data.csv`](data.csv).


## [Links](../index.md) in headers
Expand Down

0 comments on commit 329bff0

Please sign in to comment.