jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Doc] Fix some minor markup errors in manual (#20112)

Browse source 
* Fix header level for noalias pragma section.
* Fix code snippet outside of code block that raised an error with `rst2html`.
* Fix broken 'Convertible relation' links that were raising warnings.

Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
This commit is contained in:
quantimnot 2022-07-31 20:08:01 -04:00 • committed by GitHub
commit 313ce91533
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

17
doc/manual.md
View file

@ -1145,11 +1145,11 @@ The following floating-point types are pre-defined:
have the suffix 'fXX. have the suffix 'fXX.
Automatic type conversion in expressions with different kinds Automatic type conversion in expressions with different kinds of floating-point
of floating-point types is performed: See `Convertible relation`_ for further types is performed: See `Convertible relation
details. Arithmetic performed on floating-point types follows the IEEE <#type-relations-convertible-relation>`_ for further details. Arithmetic
standard. Integer types are not converted to floating-point types automatically performed on floating-point types follows the IEEE standard. Integer types are
and vice versa. not converted to floating-point types automatically and vice versa.
The IEEE standard defines five types of floating-point exceptions: The IEEE standard defines five types of floating-point exceptions:
@ -3731,9 +3731,9 @@ notation. (Thus an operator can have more than two parameters):
proc `*+` (a, b, c: int): int = proc `*+` (a, b, c: int): int =
# Multiply and add # Multiply and add
result = a * b + c result = a * b + c
```
assert `*+`(3, 4, 6) == `+`(`*`(a, b), c) assert `*+`(3, 4, 6) == `+`(`*`(a, b), c)
```
Export marker Export marker
@ -4589,7 +4589,8 @@ Converters
========== ==========
A converter is like an ordinary proc except that it enhances A converter is like an ordinary proc except that it enhances
the "implicitly convertible" type relation (see `Convertible relation`_): the "implicitly convertible" type relation (see `Convertible relation
<#type-relations-convertible-relation>`_):
```nim ```nim
# bad style ahead: Nim is not C. # bad style ahead: Nim is not C.
@ -7312,7 +7313,7 @@ This pragma has no effect on the JS backend.
Noalias pragma Noalias pragma
============== --------------
Since version 1.4 of the Nim compiler, there is a `.noalias` annotation for variables Since version 1.4 of the Nim compiler, there is a `.noalias` annotation for variables
and parameters. It is mapped directly to C/C++'s `restrict`:c: keyword and means that and parameters. It is mapped directly to C/C++'s `restrict`:c: keyword and means that