Commit Graph

217 Commits

Author SHA1 Message Date
Andrey Makarov
1c31de361d Markdown code blocks part 5 (#20236)
No logic was added, just a few more `*.md` files have been migrated.
2022-08-17 15:20:22 -04:00
Andrey Makarov
417b90a7e5 Improve Markdown code blocks & start moving docs to Markdown style (#19954)
- add additional parameters parsing (other implementations will just
  ignore them). E.g. if in RST we have:

  .. code:: nim
     :test: "nim c $1"

     ...

  then in Markdown that will be:

  ```nim test="nim c $1"
  ...
  ```

- implement Markdown interpretation of additional indentation which is
  less than 4 spaces (>=4 spaces is a code block but it's not
implemented yet). RST interpretes it as quoted block, for Markdown it's
just normal paragraphs.
- add separate `md2html` and `md2tex` commands. This is to separate
  Markdown behavior in cases when it diverges w.r.t. RST significantly —
most conspicously like in the case of additional indentation above, and
also currently the contradicting inline rule of Markdown is also turned
on only in `md2html` and `md2tex`. **Rationale:** mixing Markdown and
RST arbitrarily is a way to nowhere, we need to provide a way to fix the
particular behavior. Note that still all commands have **both** Markdown
and RST features **enabled**. In this PR `*.nim` files can be processed
only in Markdown mode, while `md2html` is for `*.md` files and
`rst2html` for `*.rst` files.
- rename `*.rst` files to `.*md` as our current default behavior is
  already Markdown-ish
- convert code blocks in `docgen.rst` to Markdown style as an example.
  Other code blocks will be converted in the follow-up PRs
- fix indentation inside Markdown code blocks — additional indentation
  is preserved there
- allow more than 3 backticks open/close blocks (tildas \~ are still not
  allowed to avoid conflict with RST adornment headings) see also
https://github.com/nim-lang/RFCs/issues/355
- better error messages
- (other) fix a bug that admonitions cannot be used in sandbox mode; fix
  annoying warning on line 2711
2022-07-15 19:27:54 +02:00
Andrey Makarov
3aaec0647b turn on syntax highlighting in Manual & Tutorial (#17692)
* turn on syntax highlighting in Manual & Tutorial

* avoid highlighting of "method"

* use relative path

* 2 more changes
2021-04-11 10:23:08 +02:00
quantimnot
83ae70cb54 RST backtick refactor (all *.rst except manual.rst and rst_examples.rst) (#17258)
Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
2021-03-18 20:37:55 -07:00
Yanis Zafirópulos
0cae8ef2ca Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
Mark
0ebc709037 deviated -> derived (#12846) [backport] 2019-12-08 20:15:19 +01:00
Andreas Rumpf
4f10b5edb6 improve documentation for 'var T return values'; refs #7373 2018-04-21 17:01:33 +02:00
Andreas Rumpf
c6f15c53f4 merge the different manual/*.rst include files. Was too hard to find the corresponding sections otherwise. Hope it means the manual is more likely to be kept up to date. 2018-04-14 08:42:53 +02:00
cooldome
16c1a90857 Cpp codegen: handling of imported exceptions. Fixes #3571 (#7360) 2018-04-10 12:14:59 +02:00
Araq
212fdc5946 added the 'x.p[:T]' notation for explicit generic instantiations in combination with the ddot calling syntax 2018-04-06 22:05:57 +02:00
Abhishek
23064bba3a fix small typo in the documentation (#7411) 2018-03-26 09:48:39 +02:00
twetzel59
d20729e840 Fix #7304 by clarifying integer width in manual (#7319)
* Fix #7304 by clarifying integer width in manual

* Update lexing.txt
2018-03-17 20:25:28 +01:00
Andreas Rumpf
3dab0877da fixes #7247 2018-02-23 11:42:19 +01:00
Andreas Rumpf
cfa96c9b13 fixes the RST in the manual 2018-02-04 00:49:47 +01:00
Andreas Rumpf
4e0b3fefa3 Merge branch 'devel' into araq-overloading-symmetry 2018-02-03 07:58:31 +01:00
Andreas Rumpf
c671356d51 manual: do not mention the VTable types which are not implemented yet 2018-02-02 17:35:04 +01:00
Andreas Rumpf
bd1dfa4b38 better type inference for numerical types; prerequisitive for version 1 2018-02-02 09:29:05 +01:00
Andreas Rumpf
7fc80f8f86 manual: do not mention the VTable types which are not implemented yet 2018-02-02 08:07:31 +01:00
konqoro
90c1edff8b Fix the names of the float checks pragmas. (#7170) 2018-02-01 14:02:32 +01:00
Andreas Rumpf
80caca15bd fixes #7089 2018-01-24 20:08:17 +01:00
Mathias Stearn
d127dd8095 Mention lack of js support in closure iterator limitations (#7110) 2018-01-19 16:51:49 +01:00
cooldome
2c9e56a783 Implement custom annotations (#6987) 2018-01-09 15:25:22 +01:00
Zach Smith
3714e2f871 Add compile-time paragraph to manual
Includes a note in the manual entry for case statements clarifying that the branch values must be known at compile time.
2017-12-30 10:50:33 +01:00
Araq
b103b4d3f2 manual: clarify the rules for integer literals 2017-12-27 10:23:57 +01:00
Andreas Rumpf
33814cf63e language change: change how the experimental dot operators work 2017-11-29 13:31:31 +01:00
Mamy Ratsimbazafy
e7c09512d2 Documentation: directly use ref object + fields (#6598) 2017-11-15 22:01:28 +01:00
Andreas Rumpf
617ba1a209 Merge branch 'devel' into araq 2017-11-07 11:17:20 +01:00
Kartik Saranathan
8b294b1186 fix broken link in manual (#6697) 2017-11-06 09:15:09 +01:00
Andreas Rumpf
1eaeccc15d Merge branch 'devel' into araq 2017-11-02 10:46:30 +01:00
Andreas Rumpf
d7a896f19d breaking change: 'and' and 'mod' do not produce a subrange type anymore; fixes #5854 2017-10-30 00:27:30 +01:00
Andreas Rumpf
c17f6c7837 new feature: package level objects 2017-10-29 07:54:39 +01:00
narimiran
489f9e96f8 Tweeks in the manual (#6599) 2017-10-26 23:02:54 +02:00
narimiran
e3c52bd4f4 fix broken link 2017-10-23 20:09:23 +02:00
Daniil Yarancev
3d69c1bd0b Constants can contain objects (excluding object variants) 2017-10-16 21:41:42 +03:00
Araq
1053c808aa minor update of the manual 2017-10-16 10:25:54 +02:00
Andreas Rumpf
e9243a1616 Merge branch 'devel' into araq 2017-10-02 08:31:38 +02:00
Araq
b2c358be96 the 'using construct is not .experimental anymore 2017-09-30 18:32:44 +02:00
jlp765
dabe4aed86 documentation improvement; make mixin easier to search (#6409) 2017-09-21 09:48:49 +02:00
superfunc
248caaf27e Update docs on assignment operator (#6373) 2017-09-15 21:49:00 +02:00
Andreas Rumpf
053b0ad6f3 Merge branch 'araq' of github.com:nim-lang/Nim into araq 2017-09-15 16:08:16 +02:00
Andreas Rumpf
39f0195ebf Merge branch 'devel' into araq 2017-09-15 09:27:51 +02:00
GULPF
9aeb78e2a8 Corrected manual (Identifier equality) (#6366)
* Corrected manual (Identifier equality)
- Clarified that identifiers are only case insensitive for ASCII characters
- Removed mention of dash-style, since it has been removed
2017-09-11 17:31:07 +02:00
Andreas Rumpf
7d8ef01e29 update the manual; 'of', 'low' and 'high' can now be overloaded 2017-09-01 08:25:43 +02:00
Jacek Sieka
22684370b0 remove ArrayDummySize with unchecked arrays (#5818) 2017-08-28 15:44:35 +02:00
Fredrik Høisæther Rasch
496716ee9b Replaced en-dash with hyphen for identifier equality (#6272) 2017-08-24 20:53:50 +02:00
Zahary Karadjov
7ad115f530 Restore the old behavior of parsing "quote do:"
close #5845
2017-08-19 08:57:43 +02:00
Andreas Rumpf
bc738d63a7 no interval arithmetic anymore to construct implicit range types; breaking change 2017-07-13 05:13:12 +02:00
Dan
f682bb6de0 Update pragmas.txt (#6006)
Added more info on how the format strings work for codegenDecl
2017-06-21 15:36:50 +02:00
Zahary Karadjov
672c24e4b8 fix affecting templates with explicit generic params 2017-05-13 20:48:44 +03:00
Zahary Karadjov
7e0c66ffe7 manual additions for the covariant generic parameters 2017-05-12 21:27:32 +03:00