summary refs log tree commit diff stats
path: root/doc
diff options
context:
space:
mode:
authorquantimnot <54247259+quantimnot@users.noreply.github.com>2022-07-31 20:08:01 -0400
committerGitHub <noreply@github.com>2022-07-31 20:08:01 -0400
commit313ce91533f0eb1217093a09678c3775df670411 (patch)
tree15b1884e7fc08c8ee702842a3985f3ca81a4340f /doc
parenta8590d6707ebc5e1e278cd45f43acd15f5f92fe4 (diff)
downloadNim-313ce91533f0eb1217093a09678c3775df670411.tar.gz
[Doc] Fix some minor markup errors in manual (#20112)
* 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>
Diffstat (limited to 'doc')
-rw-r--r--doc/manual.md17
1 files changed, 9 insertions, 8 deletions
diff --git a/doc/manual.md b/doc/manual.md
index ae9ad5aad..75ed3d014 100644
--- a/doc/manual.md
+++ b/doc/manual.md
@@ -1145,11 +1145,11 @@ The following floating-point types are pre-defined:
   have the suffix 'fXX.
 
 
-Automatic type conversion in expressions with different kinds
-of floating-point types is performed: See `Convertible relation`_ for further
-details. Arithmetic performed on floating-point types follows the IEEE
-standard. Integer types are not converted to floating-point types automatically
-and vice versa.
+Automatic type conversion in expressions with different kinds of floating-point
+types is performed: See `Convertible relation
+<#type-relations-convertible-relation>`_ for further details. Arithmetic
+performed on floating-point types follows the IEEE standard. Integer types are
+not converted to floating-point types automatically and vice versa.
 
 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 =
     # Multiply and add
     result = a * b + c
-  ```
 
   assert `*+`(3, 4, 6) == `+`(`*`(a, b), c)
+  ```
 
 
 Export marker
@@ -4589,7 +4589,8 @@ Converters
 ==========
 
 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
   # bad style ahead: Nim is not C.
@@ -7312,7 +7313,7 @@ This pragma has no effect on the JS backend.
 
 
 Noalias pragma
-==============
+--------------
 
 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