summary refs log tree commit diff stats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Don't use `unittest.suite` and `unittest.test` (#16464)flywind2020-12-271-1/+1
|
* removing `out T` from docs since it no longer working (#16378) [backport]Code Hz2020-12-181-21/+10
| | | | | | | | | * remove `out T` from docs see https://github.com/nim-lang/Nim/issues/16131 * remove `out T` in title * remove entire paragraph
* Add note about minimum Node.js version (#16370)Maurizio Tomasi2020-12-161-0/+3
| | | Fix the error message
* Syntax (RST) fix Internals of the Compiler (#16341)Saem Ghani2020-12-151-6/+6
| | | | | 'Rebuilding the Compiler' and a few other sections required syntax fixes: * new lines before and after lists to fix rendering * use internal reference instead of Markdown style link
* Fix broken links in docs (#16336)Elliot Waite2020-12-143-5/+5
| | | | | * Fix broken links in docs * Fix rand HSlice links
* testament: error instead of silently ignore invalid targets; remove ↵Timothee Cour2020-12-141-3/+6
| | | | | | | | | | | pointless alias target vs targets; document matrix; DRY (#16343) * testament: error instead of silently ignore invalid targets * s/target/targets/ * fix test; refs #16344 * address comments * Update testament/specs.nim Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* RST tables: fix latex col number; allow less than three of `=` (#16040)Andrey Makarov2020-12-041-2/+2
|
* styleCheck: Fix error for `sugar` and `std/with` (#16176)ee72020-12-021-1/+1
| | | | | | | | | | | | | | | | With this commit, we no longer see an error if we pass `--styleCheck:error` when compiling a file that contains `import sugar` or `import std/with`. The problem was that those modules (and only those modules) import `std/private/underscored_calls`, which contained a styleCheck issue: its spelling of `nnkArgList` didn't match the `nnkArglist` spelling in `macros.nim`. This commit fixes the issue by renaming `nnkArgList` to `nnkArglist` repo-wide. The other way around would be a breaking change for code that used `nnkArglist` and `--styleCheck:error`. Fixes: #16174
* fixed article duplication typos (#16216)ihlec2020-12-022-2/+2
|
* remove all mentions of doc2, jsondoc2 (except 1 mentioning the alias) (#15683)Timothee Cour2020-11-265-9/+9
|
* fix #16047 (#16066)Miran2020-11-201-1/+3
|
* fix numbering in contributing.rst (#16042)Timothee Cour2020-11-181-6/+4
|
* contributing docs: always mentioned referenced issues in PR body (#16038)Timothee Cour2020-11-181-3/+10
|
* defer: improve manual, clarify difference wrt try/finally (#16010)Timothee Cour2020-11-171-2/+31
|
* https://github.com/nim-lang/Nim/pull/15968/files#r523468677Juan Carlos2020-11-141-7/+1
|
* Fix #15806Juan Carlos2020-11-141-1/+2
|
* Fix #15806Juan Carlos2020-11-141-2/+3
|
* Fix #15806Juan Carlos2020-11-141-1/+2
|
* Fix #15806Juan Carlos2020-11-141-1/+30
|
* [docs minor]add some tips to intern.rst (#15967)Andreas Rumpf2020-11-141-2/+10
|\ | | | | | | | | * [docs minor]add some tips yo intern.rst * minor
| * minorflywind2020-11-141-1/+1
| |
| * [docs minor]add some tips yo intern.rstflywind2020-11-141-2/+10
| |
* | targets: use cpp instead of c++ everywhere (was by far the most common) (#15961)Timothee Cour2020-11-141-1/+1
| |
* | follow #8463 #14157 and document cstring literals modification is not ↵flywind2020-11-121-0/+14
| | | | | | | | | | | | | | | | | | allowed (#15878) * follow #8463 #14157 and document cstring literals * Update doc/manual.rst Co-authored-by: Juan Carlos <juancarlospaco@gmail.com> Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* | nimdoc: items of ordered lists now have numbers instead of circlesnarimiran2020-11-111-1/+1
| |
* | remove `codeowners` [ci skip]narimiran2020-11-112-69/+1
| |
* | new: `nim -e:cmd` to run a command directly; also fixes #15731 (#15687)Timothee Cour2020-11-091-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * new: `nim -i cmd` * rename -i to -e (for eval); consistent with majority of other programing languages * `nim e -e:cmd` now works; bugfix: `echo cmd | nim e -` now works * honor --betterRun * address comments * --eval alias for -e (replaces undocumented --eval which was a noop) * --eval now defaults to e (nimscript) instead of r * address comment: remove -e, only keep --eval * address comment * fixup * Update compiler/nimconf.nim Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* | Added [:T] syntax explanation to generics tutorial. (#15890)Aethylia2020-11-091-0/+13
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* | improve Testament docs (#15881)n5m2020-11-091-4/+6
| | | | | | | | | | * fix mentions of recursive test discovery * document that {.fatal.} pragmas cannot be caught
* | include example of error-marked copy proc (#15886)n5m2020-11-091-1/+7
| | | | | | | | | | * include example of error-marked copy proc * Update destructors.rst
* | uint and uint64 is Ordinal type since nim 1.0.0 (#15873)flywind2020-11-071-3/+1
| |
* | Make `{.requiresInit.}` to work for distinct types (#15869)Ivan Bobev2020-11-061-0/+30
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Make `requiresInit` pragma to work for distinct types in addition to objects. Tagging of distinct types with `requiresInit` pragma was already supported, but its impact wasn't applied. Now its behavior when applied on distinct types is as follows. Given the following distinct type definitions: ```nim type DistinctObject {.requiresInit, borrow: `.`.} = distinct MyObject DistinctString {.requiresInit.} = distinct string ``` The following code blocks will fail to compile: ```nim var foo: DistinctFoo foo.x = "test" doAssert foo.x == "test" ``` ```nim var s: DistinctString s = "test" doAssert s == "test" ``` But these ones will compile successfully: ```nim let foo = DistinctFoo(Foo(x: "test")) doAssert foo.x == "test" ``` ```nim let s = "test" doAssert s == "test" ```
* | micro improvements (#15849)Andreas Rumpf2020-11-051-1/+1
| |
* | Clarify the sense in which Nim supports recursive iterators in the (#15834)c-blake2020-11-042-5/+42
| | | | | | manual, the tutorial, and the `tbintree` test.
* | remove iup from stdlib in contrast to #15828 (#15830)flywind2020-11-031-7/+0
|/ | | | | * remove iup from stdlib * Update changelog.md
* TyposClyybber2020-10-311-1/+1
|
* improve public Testament docs (#15710)n5m2020-10-311-27/+80
| | | | | | | | | | | | | | | * improve glob docs * punctuation * move spec descriptions above example notably, change the description of timeout to reference seconds, not microseconds * document nimout * document sortoutput * explain the action options
* Massive documentation fixes + copy editing (#15747)Yanis Zafirópulos2020-10-2916-411/+401
|
* Spelling and Grammer fixes (#15719)Tim Smith2020-10-281-2/+6
| | | | Co-authored-by: Tim Smith <tim.smith.hdg@gmail.com> Co-authored-by: Miran <narimiran@disroot.org>
* Document implicit return values from procedures (#15738)Xavier Noria2020-10-271-0/+10
|
* Copy editing (#15733)Yanis Zafirópulos2020-10-262-34/+34
| | | | | | | | | * Minor fixes * Minor fixes * Minor fixes * Minor fixes
* [backport: 1.4] Better linebreaks (#15658)Miran2020-10-221-1/+0
|
* Fix #13609 (#15567)Gampol T2020-10-211-0/+11
| | | | | | | | | | | | | * add documentation that discardable pragma cannot use on template * Update doc/manual.rst Co-authored-by: Euan <euantorano@users.noreply.github.com> * Update doc/manual.rst Co-authored-by: Euan <euantorano@users.noreply.github.com> Co-authored-by: Euan <euantorano@users.noreply.github.com>
* --declaredlocs => --declaredLocs (#15672)Timothee Cour2020-10-211-1/+1
|
* add --declaredlocs (#15666)Timothee Cour2020-10-211-0/+1
|
* make patchFile more discoverable (#15659)Timothee Cour2020-10-201-0/+1
|
* gc.rst: updated the docs to reflect realityAraq2020-10-201-2/+1
|
* Remove bit about opening files not raising (#15654)Tomáš Hübelbauer2020-10-201-4/+2
| | | | | 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.
* more "eg" fixesnarimiran2020-10-208-8/+8
|
* it is not "eg", it is "e.g."narimiran2020-10-201-5/+5
|