Commit Graph

26 Commits

Author SHA1 Message Date
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
flywind
69a78c9183 promote std prefix in docs (#17128) 2021-02-20 22:38:29 -08:00
Timothee Cour
13b1b19a83 remove all mentions of doc2, jsondoc2 (except 1 mentioning the alias) (#15683) 2020-11-26 11:54:18 -08:00
Aethylia
53eca459f1 Added [:T] syntax explanation to generics tutorial. (#15890)
* Added [:T] syntax explanation to generics tutorial.

* Update doc/tut2.rst

Co-authored-by: flywind <43030857+xflywind@users.noreply.github.com>

* Update doc/tut2.rst

Co-authored-by: flywind <43030857+xflywind@users.noreply.github.com>

* Made second generics example runnable and added test line.

* Update doc/tut2.rst

* Update doc/tut2.rst

* Update doc/tut2.rst

Co-authored-by: flywind <43030857+xflywind@users.noreply.github.com>
Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
2020-11-09 14:14:06 +01:00
c-blake
f17555770e Clarify the sense in which Nim supports recursive iterators in the (#15834)
manual, the tutorial, and the `tbintree` test.
2020-11-04 16:56:22 +01:00
Tomáš Hübelbauer
725c7caa02 Remove bit about opening files not raising (#15654)
Resolved #473 

I am removing this bit because this advice to not throw on recoverable-from cases like a file failing to open is actually not respected by Nim standard library. `readFile` and `readLines` both throw and exceptions must be used as a method of control flow for the recovery from that. There are alternatives, like opening a file handle instead of using these helpers, but that's less convenient than these helper methods for cases where you really want to just slurp up a file to memory and use a fallback value if it doesn't exist or is for whatever reason not readable.
2020-10-20 13:36:19 +02:00
Jacek Sieka
7d6cbf290a Error -> Defect for defects (#13908)
* Error -> Defect for defects

The distinction between Error and Defect is subjective,
context-dependent and somewhat arbitrary, so when looking at an
exception, it's hard to guess what it is - this happens often when
looking at a `raises` list _without_ opening the corresponding
definition and digging through layers of inheritance.

With the help of a little consistency in naming, it's at least possible
to start disentangling the two error types and the standard lib can set
a good example here.
2020-04-28 19:56:01 +02:00
hlaaftana
b2141fc2a1 changed type() to typeof() in docs and error messages (#14084) 2020-04-24 09:22:12 +02:00
Rory O’Kane
a8a464810e [ci skip] docs: make the syntax for generics easy to look up (#13754) 2020-03-25 21:09:23 +01:00
Rory O’Kane
febd48f343 [skip ci] docs: reword Part 3 link to communicate that it exists (#13755) 2020-03-25 21:08:24 +01:00
Kaushal Modi
c656714623 [bugfix] Minor formatting fix in tut2 [ci skip] (#11501)
Monospace `untyped` like elsewhere in the tutorial.
2019-06-14 15:13:44 +02:00
Andreas Rumpf
ef8ddef47b fixes #10912 (#11317)
* fixes #10912

* update the tutorial examples
2019-05-24 18:33:53 +02:00
Andreas Rumpf
4d0f05a98a manual.rst: move experimental features to manual_experimental 2019-03-27 15:08:32 +01:00
Miran
afeca3d9fe multi-methods need to be explicitly enabled (#10856)
* multi-methods need to be explicitly enabled

* update changelog, manual and tutorial
2019-03-18 08:21:37 +01:00
Arne Döring
80992c7a12 introduce object before tuple in the tutorials (#10664) 2019-02-14 22:17:05 +01:00
Arne Döring
30480605c1 added a new macro tutorial (#9588) 2018-11-21 15:46:58 +01:00
Zahary Karadjov
ea36e0ebbe document the new type[T] and static[T] features 2018-06-16 16:46:32 +03:00
Araq
58c3e5d2f5 test the snippets in tut2.rst 2017-11-28 01:25:59 +01:00
Mamy Ratsimbazafy
e7c09512d2 Documentation: directly use ref object + fields (#6598) 2017-11-15 22:01:28 +01:00
Zahary Karadjov
4483cefa0c fix #5918 2017-08-19 08:57:43 +02:00
Araq
36a26875ef show splitWhitespace instead of split in tut2 2017-08-13 02:51:00 +02:00
Andreas Rumpf
44bd4d8774 fixes #6125 2017-07-22 17:20:33 +02:00
Ganesh Viswanathan
16619b8e78 Fix for issue #6044. (#6056) 2017-07-06 08:04:42 +02:00
jlp765
86c73cdfc2 Further tutorial updates (#5176)
* tut1: added multiline comments
* tut2: replaced expr/stmt with untyped/typed
* added some more template/macro example
* remove immediate pragma from example
2017-01-07 09:18:45 +01:00
Simon Ruderich
6a0d288cae doc: tut2: simplify debug macro example 2016-09-15 11:43:57 +02:00
Araq
eed0128916 renamed most remaining .txt documentation files to .rst 2016-06-07 04:04:49 +02:00