Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix typos #22869

Merged
merged 1 commit into from
Oct 25, 2023
Merged

doc: fix typos #22869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/docgen.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -621,7 +621,7 @@ compilation options are different:
.. Note:: markup documents are just placed into the specified directory
`OUTDIR`:option: by default (i.e. they are **not** affected by
`--project`:option:), so if you have ``PROJECT/doc/manual.md``
document and want to use complex hirearchy (with ``doc/``),
document and want to use complex hierarchy (with ``doc/``),
compile it with `--docroot`:option:\:
```cmd
# 1st stage
Expand Down Expand Up @@ -688,7 +688,7 @@ the rest optional. See the [Index (idx) file format] section for details.

.. Note:: `--index`:option: switch only affects creation of ``.idx``
index files, while user-searchable Index HTML file is created by
`buildIndex`:option: commmand.
`buildIndex`:option: command.

Buildindex command
------------------
Expand Down
2 changes: 1 addition & 1 deletion doc/manual_experimental.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2378,7 +2378,7 @@ proc makeCppClass(): NimClass {.constructor: "NimClass() : CppClass(0, 0)".} =
result.x = 1
```

In the example above `CppClass` has a deleted default constructor. Notice how by using the constructor syntax, one can call the appropiate constructor.
In the example above `CppClass` has a deleted default constructor. Notice how by using the constructor syntax, one can call the appropriate constructor.

Notice when calling a constructor in the section of a global variable initialization, it will be called before `NimMain` meaning Nim is not fully initialized.

Expand Down
2 changes: 1 addition & 1 deletion doc/markdown_rst.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ nim md2html file2.md # creates ``htmldocs/file2.html``
```

To allow cross-references between any files in any order (especially, if
circular references are present), it's strongly reccommended
circular references are present), it's strongly recommended
to make a run for creating all the indexes first:

```cmd
Expand Down
2 changes: 1 addition & 1 deletion doc/nimc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,7 @@ DLL generation
==============

**Note**: The same rules apply to `lib*.so` shared object files on UNIX. For better
readability only the DLL version is decribed here.
readability only the DLL version is described here.

Nim supports the generation of DLLs. However, there must be only one
instance of the GC per process/address space. This instance is contained in
Expand Down