summary refs log tree commit diff stats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* spec: be explicit that NRVO will evolve furtherAraq2020-05-301-0/+4
|
* document NVRO and exception handlingAraq2020-05-301-0/+65
|
* make it easier to figure out how to debug issues (#14477)Timothee Cour2020-05-281-1/+30
|
* Add thiscall calling convention, mostly for hooking purpose (#14466)Huy Doan2020-05-271-0/+4
| | | | * Add thiscall calling convention, mostly for hooking purpose * add changelog and documentation
* fix #6583, fix #14376, index+search now generated for all projects, many bug ↵Timothee Cour2020-05-251-2/+10
| | | | | | | | | fixes with nim doc (#14324) * refs #6583 fix nim doc output * changelog * change default for outDir when unspecified * cleanups * --project implies --index
* manual.rst: updates [backport] (#14445)Andreas Rumpf2020-05-251-23/+24
|
* Fix some typos in the manual [backport] (#14399)Danil Yarantsev2020-05-201-10/+10
|
* refs #14369 improve docs for importcpp exceptions (#14391)Timothee Cour2020-05-181-8/+30
| | | | | * refs #14369 improve docs for importcpp exceptions * address comments
* docs:getCurrentException() and getCurrentExceptionMsg() are not available ↵cooldome2020-05-181-1/+3
| | | | for imported exceptions (#14392)
* docs: fix syntax error in hotCodeReloading example (fixes #14380) (#14381)Frank Schmitt2020-05-171-1/+1
| | | Co-authored-by: Frank Schmitt <frankschmitt@gmx.de>
* docfix: fix wrong link in doc/manual.rst (#14367)Bung2020-05-161-1/+1
|
* Allow let to not have value when using importc (#14258)PMunch2020-05-121-0/+15
| | | | | | | | | | | | | | * Allow let to not have value when using importc This allows a let statement with the `{.importc.}` pragma to not be initialised with a value. This allows us to declare C constants as Nim lets without putting the value in the Nim code (which can lead to errors, and requires us to go looking for the value). Fixes #14253 * Proper fix and documentation + changelog entry * Improve testcase with one from timotheecour * Add test to verify it working with macros
* fixes #13881Andreas Rumpf2020-05-121-3/+44
| | | | | | * fixes #13881 * documented changed requirements for system.onThreadDestruction * destructors.rst: update the documentation
* Added a reference to ternary operators. (#14309)Avahe Kellenberger2020-05-121-0/+1
| | | | | `if expressions` are similar to ternary operators in other languages. In order to make this easier to find in the manual, I've added a sentence about it.
* do not track 'raise Defect' in the .raises: [] clause anymore (#14298)Andreas Rumpf2020-05-111-0/+22
| | | | | | | | | * do not track 'raise Defect' in the .raises: [] clause anymore * --panics:on maps 'raise Defect' to an unrecoverable fatal error * make tests green again * update the documentation too
* `nim doc --backend:js`, `nim doc --doccmd:-d:foo`, `nim r --backend:js`, ↵Timothee Cour2020-05-112-4/+13
| | | | | | | | | | `--doccmd:skip` + other improvements (#14278) * `nim doc --backend:js|cpp...` `nim doc --doccmd:'-d:foo --threads:on'` `nim r --backend:cpp...` (implies --run --usenimcache) * --usenimcache works with all targets * --docCmd:skip now skips compiling snippets; 50X speedup for doc/manual.rst
* Fix typoClyybber2020-05-081-1/+1
|
* make `from` an operator (#14241)hlaaftana2020-05-082-17/+17
|
* added a new feature: --cc:env so that you can use any C compiler as long as ↵Andreas Rumpf2020-05-061-0/+4
| | | | it works like GCC
* Clarify JS cstring len (#14184)hlaaftana2020-05-051-1/+1
|
* exp. features now in correct manual, closes #11932 (#14195)hlaaftana2020-05-022-171/+184
|
* discardable async procs are now an error (#14176)hlaaftana2020-05-011-1/+2
| | | | * add discard warning in manual
* Error -> Defect for defects (#13908)Jacek Sieka2020-04-284-21/+21
| | | | | | | | | | | | | | * 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.
* StringStream & more stdlib modules support for JS/NimScript (#14095)hlaaftana2020-04-282-7/+7
| | | | | * StringStream & more stdlib modules support for JS/NimScript * change back pegs test in line with #14134
* Update grammar.txt with `func` and `as` (#14147) [backport]hlaaftana2020-04-281-1/+2
|
* changed type() to typeof() in docs and error messages (#14084)hlaaftana2020-04-244-6/+6
|
* CT sizeof(+friends) for {.importc, completeStruct.} types, enable ABI static ↵Timothee Cour2020-04-231-3/+2
| | | | | | | | | | | checks (#13926) * -d:checkabi obsolete (ABI check now enforced); add `addTypeHeader` helper * cleanups * import sizeof at CT for {.completeType.} * address comments; revert default enabling of -d:checkAbi for now * mimportc_size_check.nim => msizeof5.nim; merge mabi_check.nim into msizeof5.nim; refactor * all pragmas in errmsgs should be written: '.importc' (un-ambiguous and less verbose than {.importc.})
* new cmd: `nim r main [args...]` to compile & run, saving binary under ↵Timothee Cour2020-04-231-0/+1
| | | | | | $nimcache/main (#13382) * implement `nim r main` to compile and run, saving binary to $nimcache * remove outFileAbs for now
* docs: move `not nil` to the experimental page (#14027)Rory O’Kane2020-04-212-26/+30
| | | | | When I heard that this feature existed, and found the 2018 changelog entry that said `not nil` was made experimental (https://github.com/nim-lang/Nim/blob/devel/changelogs/changelog_0_19_0.md#changes-affecting-backwards-compatibility), I looked for `not nil` documentation in https://nim-lang.org/docs/manual_experimental.html. When I didn’t find it there, I initially assumed the feature had no documentation. This change moves the documentation to where readers will expect it. As well as moving the text to another file, I added instructions for enabling the experimental feature and tweaked some wording.
* clarify tuples and objects in manual, fixes #12486 (#14044)hlaaftana2020-04-211-7/+20
|
* Fix #13972 (#14034)Clyybber2020-04-201-2/+2
|
* Update code example to match new sdl2.nim syntax (#13924)Lưu Danh, Hiếu2020-04-201-25/+43
| | | | | | | | | | | | | | | | | * Update code example to match new sdl2.nim syntax Signed-off-by: Hieu Luu Danh <hieu@vivu.asia> * Modify on recommendation of @alaviss - Removed trailing whitespaces - Detailed how to compile libnimhcr and libnimrtl - Fixed some logic in example code * Modify following recommendations of @alaviss - Rewording so that it conforms to Windows/Linux/MacOS Signed-off-by: Hieu Luu Danh <hieu@vivu.asia>
* remove the nilChecks switch; refs #11570Araq2020-04-201-1/+0
|
* Grammar correction in backends.rst (#13989)Adam Weber2020-04-161-2/+2
| | | I hate to be the guy that submits a couple grammatical/spelling corrections.
* drnim: tiny progress (#13882)Andreas Rumpf2020-04-152-5/+6
| | | | | | | | | | | * drnim: tiny progress * refactoring complete * drnim: prove .ensures annotations * Moved code around to avoid code duplication * drnim: first implementation of the 'old' property * drnim: be precise about the assignment statement * first implementation of --assumeUnique * progress on forall/exists handling
* new feature: ability to turn specific warnings to errorsAndreas Rumpf2020-04-041-0/+2
|
* Small typo (#13824)Clyybber2020-03-311-1/+1
|
* DrNim (Nim compiler with Z3 integration) (#13743)Andreas Rumpf2020-03-311-0/+203
| | | | | | | | | | | | | | | | | | | | | | | | * code cleanups and feature additions * added basic test and koch/CI integration * make it build on Unix * DrNim: now buildable on Unix, only takes 10 minutes, enjoy * added basic documentation for DrNim which can also be seen as the RFC we're following * drnim: change the build setup so that drnim.exe ends up in bin/ * makes simple floating point ranges work * added basic float range check * drnim: teach Z3 about Nim's range types plus code refactoring * drnim: make unsigned numbers work * added and fixed index checking under setLen * first implementation of .ensures, .invariant and .assume (.requires still missing and so is proc type compatibility checking * drnim: .requires checking implemented * drnim: implemented .ensures properly * more impressive test involving min() * drnim: check for proc type compatibility and base method compatibility wrt .requires and .ensures * testament: support for 'pattern <directory> * koch: uses new <directory> feature of testament * drnim: added tiny musings about 'old' * Make testament work with old SSL versions * koch: add support for 'koch drnim -d:release' * drnim: preparations for the param.old notation
* macros for proc types, macros for types (#13778)Andreas Rumpf2020-03-311-44/+74
| | | | | | | | | * new minor feature: macros for proc types, to be documented * Finished the implementation and added tests * [skip ci] Describe the new custom pragmas in the manual and the changelog Co-authored-by: Zahary Karadjov <zahary@gmail.com>
* stacktraces can now show custom runtime msgs per frame (#13351)Timothee Cour2020-03-301-0/+1
| | | | | | | | * stacktraces can now show custom runtime msgs * improve tests/stdlib/tstackframes.nim * fix test for --gc:arc * test --stacktraceMsgs:on and --stacktraceMsgs:off * --stacktracemsgs:off by default
* [ci skip] docs: make the syntax for generics easy to look up (#13754)Rory O’Kane2020-03-251-1/+2
|
* [skip ci] docs: reword Part 3 link to communicate that it exists (#13755)Rory O’Kane2020-03-251-1/+1
|
* docs: say that `nil` can be used as a value (#13756)Rory O’Kane2020-03-251-5/+8
| | | | | and improve wording in other ways Showing that `nil` can be assigned helps to warn readers that variables can be `nil` even after being assigned a value.
* gc.rst that doesn't lie (#13686)Andreas Rumpf2020-03-191-54/+34
|
* Documentation GC (#13109)Juan Carlos2020-03-181-76/+98
| | | | | | | | | | | | | | | | * Update Documentation about GC, add ARC based on code observations and https://forum.nim-lang.org/t/5734#35562 * Rephrase 'Garbage Collector' on documentation, see #13331 * Peer Review Feedbacks * When the body of a documentation section is all for garbage collector details then add 'for garbage collectors' to the title to identify they may not apply for ARC * Change 'GC' for 'garbage collector'. * Move 'Memory Management Strategies' at the top, without changes * Move the info for RefC GC from 'Introduction' to 'RefC' section without changes, make 'Introduction' about Nims 'Multi-paradigm Memory Management Strategies'.
* arc optimizations (#13325)Andreas Rumpf2020-03-181-0/+1
| | | | | * scope based destructors * handle 'or' and 'and' expressions properly, see the new test arc/tcontrolflow.nim * make this branch mergable, logic is disabled for now
* fix typo (#13660) [ci skip]Kartik Saranathan2020-03-161-1/+1
|
* fix #13218: avoid some irrelevant warnings for nim doc,rst2html,--app:lib, + ↵Timothee Cour2020-03-131-2/+2
| | | | | | | | other fixes (#13550) * fix #13218: avoid some irrelevant warnings for nim doc,rst2html * suppress warnRedefinitionOfLabel for nim doc * lots of fixes for UnusedImport warnings
* catchable defects (#13626)Andreas Rumpf2020-03-122-13/+22
| | | | | | | | | | * allow defects to be caught even for --exceptions:goto (WIP) * implemented the new --panics:on|off switch; refs https://github.com/nim-lang/RFCs/issues/180 * new implementation for integer overflow checking * produce a warning if a user-defined exception type inherits from Exception directly * applied Timothee's suggestions; improved the documentation and replace the term 'checked runtime check' by 'panic' * fixes #13627 * don't inherit from Exception directly
* Only print the link command when listCmd is active; fix docs (#13603)Clyybber2020-03-071-2/+2
|