summary refs log tree commit diff stats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Document how to compile a reproducible build (#18953)quantimnot2021-10-062-0/+15
| | | | | | | | | | | | | | | | | | | | | | * Make compiler build more reproducible Removed the compile time from the version output. Added Git commit's author's datetime in UTC timezone. Fixes #18508 See https://reproducible-builds.org/docs/timestamps/ See https://reproducible-builds.org/docs/source-date-epoch/ * Revert "Make compiler build more reproducible" This reverts commit 2f9359ae89622c2d95ef243d13251a310e94a199. Documented how to use compile reproducible builds with the `SOURCE_DATE_EPOCH` environment variable. * Corrected `readme.md` formatting Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
* typo [backport] (#18948)Andreas Rumpf2021-10-041-1/+1
|
* typos [backport] (#18929)Andreas Rumpf2021-09-301-10/+11
|
* fix wrong name (rnimsyn => renderer; pnimsyn => parser; scanner => lexer) ↵flywind2021-09-251-1/+1
| | | | | | | (#18895) * fix wrong module name * rephrase more word
* [backport] change some examples in tut1.rst (#18884)Miran2021-09-241-12/+35
| | | | | | | | | * [backport] change some examples in tut1.rst * Update doc/tut1.rst * Update doc/tut1.rst Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* documented overload disambiguation [backport] (#18865)Andreas Rumpf2021-09-191-1/+19
| | | | | | | | | | | | | * documented overload disambiguation [backport] * Update doc/manual.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * documented overload disambiguation [backport] * documented overload disambiguation [backport] Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
* doc improvements (#18843)Andreas Rumpf2021-09-132-138/+33
| | | | | * cleaned up destructors documentation [backport] * Spec updates [backport:1.0]
* formal grammar updates [backport:1.2] (#18803)Andreas Rumpf2021-09-041-21/+16
|
* remove channels (#18801)flywind2021-09-041-1/+1
| | | | | * remove channels * test
* documented overloadable enums and changelog improvements (#18797)Andreas Rumpf2021-09-041-0/+41
|
* implements https://github.com/nim-lang/RFCs/issues/407 (#18793)Andreas Rumpf2021-09-031-0/+35
|
* implemented Unicode operators (#18789)Andreas Rumpf2021-09-031-0/+19
| | | | | | | | | | | | | | | * implemented Unicode operators; refs https://github.com/nim-lang/RFCs/issues/388 * bugfix * better test * arguably more elegant implementation * Update changelog.md Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
* strict effects (#18777)Andreas Rumpf2021-09-021-107/+145
| | | | | | | | | | | | | | | | | * fixes #17369 * megatest is green for --cpu:arm64 * docgen output includes more tags/raises * implemented 'effectsOf' * algorithm.nim: uses new effectsOf annotation * closes #18376 * closes #17475 * closes #13905 * allow effectsOf: [a, b] * added a test case * parameters that are not ours cannot be declared as .effectsOf * documentation * manual: added the 'sort' example * bootstrap with the new better options
* Remove `Covariance` section from the experimental manual (#18688)konsumlamm2021-08-291-101/+63
| | | | | | | * Remove `Covariance` section * Add blank lines after `.. code-block::` * Fix CI?
* fix RFC #341: dot-like operators are now parsed with same precedence as `.` ↵Timothee Cour2021-08-252-0/+11
| | | | | | | | | | | | | | | | | | | | | (#18711) * fix RFC #341: dot-like operators are now parsed with same precedence as `.` * fixup * [skip ci] address comment in changelog * address comment * update grammmar * add manual entry * fixup * -d:nimPreviewDotLikeOps * address comment to unblock PR: move nimPreviewDotLikeOps out of config/config.nims
* fix deprecated example (#18721)flywind2021-08-211-4/+12
|
* [docs]fix an item missing (#18717)flywind2021-08-201-0/+1
|
* cross compilation targetting windows now supports `nim r`: `nim r -d:mingw ↵Timothee Cour2021-08-161-0/+2
| | | | | | | | | main` (#18682) * cross compilation targetting windows now supports `nim r`: `nim r -d:mingw main` * quoteShell * address comment: remove `conf.getConfigVar("nimrun.exe")`
* manual: minor improvements (#18687)Andreas Rumpf2021-08-131-12/+9
|
* Switch maintanance (#18668)RSDuck2021-08-111-10/+11
| | | | | | | | | * Fix and improve Nintendo Switch support * Document the necessity for nimAllocPagesViaMalloc * update changelog * Use --gc:orc in examples
* Documentation only, add 1 example (#18621)Juan Carlos2021-08-081-1/+21
| | | | | | | | | | | | | | | * ReSync with Devel * ReSync * Documentation only, add 1 example to For loop macro * Flip it * Update doc/manual.rst Co-authored-by: Andreas Rumpf <rumpf_a@web.de> Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* Documentation only, add 1 example (#18633)Juan Carlos2021-08-031-0/+18
|
* docgen: draw frame around active anchors (#18607)Andrey Makarov2021-07-291-0/+6
|
* Update `lib.rst` (#18605)konsumlamm2021-07-291-24/+20
| | | | | | | | | | | | | * Update lib.rst * Remove "Unstable" category Add `strbasics` * Update doc/lib.rst * Update doc/lib.rst Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* Clarify use of import via pseudo dir... (#18569)GordonBGood2021-07-271-0/+1
|
* mitigates #12815 (#18557)Andreas Rumpf2021-07-221-0/+2
| | | | | | | | | * mitigates #12815 * Update doc/nimc.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
* fixes #12815 (#18554)Andreas Rumpf2021-07-221-0/+6
|
* fixes #18550 (#18553)Andreas Rumpf2021-07-211-4/+3
| | | | | * fixes #18550 * update the manual to reflect reality
* breaking changes policies (#18541)Andreas Rumpf2021-07-211-0/+114
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * document some std library evolution policies In wanting to improve the standard library, it's helpful to have a set of principles and guidelines to lean back on, that show how to introduce such improvements while at the same time considering existing users of the language. A key idea behind documentation of this sort is that it should highlight a path forwards in making changes rather than trying to prevent them, and although the current snippet does include some language for what one shouldn't do, it also shows a few options for what one can do. This is a riff on https://github.com/nim-lang/Nim/pull/18468 mainly based on what helps enable to the use of Nim productively in environments and teams where the priority and focus is not always on the tool (Nim in this case) but rather on the codebase itself, and its use by end users. We use similar guidance documentation to help coordinate the code of the teams using Nim in https://status-im.github.io/nim-style-guide/ where it is applied not as law, but rather as recommendations for the default approach that should be considered first. * document the new policies * typo * Update doc/contributing.rst Co-authored-by: Timothee Cour <timothee.cour2@gmail.com> * Update doc/contributing.rst * Update doc/contributing.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/contributing.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/contributing.rst * Update doc/contributing.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * clarify some things * Update doc/contributing.rst Co-authored-by: Dominik Picheta <dominikpicheta@googlemail.com> Co-authored-by: Jacek Sieka <arnetheduck@gmail.com> Co-authored-by: Timothee Cour <timothee.cour2@gmail.com> Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> Co-authored-by: Dominik Picheta <dominikpicheta@googlemail.com>
* use more `.}` (#18542)flywind2021-07-201-2/+2
|
* Docs(manual): add clarification for default params (#18522)ynfle2021-07-191-1/+2
| | | | | | | | | | | * Docs(manual): add clarification for default params * Docs(manual): fix wording to refer to call time * Docs(manual): Clarify default parameter wording Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
* added `nimAllocPagesViaMalloc` switch (#18490)Andreas Rumpf2021-07-151-1/+13
| | | | | * added switch * alloc.nim needs page aligned memory blocks
* Improve description of how =trace is used (#18491)GordonBGood2021-07-151-5/+22
| | | | | | | | | | | | | | | | | | | * [skip ci] thamming_orc test created/destroyed counts match The thamming_orc.nim code now counts all created objects being tested, not just the ones following the "first 20" test, and the position of the `destroyed += 1` counter has been adjusted so it counts all the calls that are as a result of `=trace` tracing and not just the original destruction calls. * Improve description of how `=trace` is used The following nuances weren't previously fully explained: 1. That `=trace` is only used by `--gc:orc`. 2. That `=trace` is almost certainly used along with `=destroy` when manual resource allocation has been used, but it is only required if there is a possibility of cyclic references in the wrapped types (ie. generic types). 3. That, currently, a forward definition is required for the second of the pair to avoid an auto compiler generation conflict. The pattern of the use of `=trace` has also been made more extensive, showing how both a custom `=destroy` and `=trace` are used for manual allocation of resources when there is any possibility of a cyclic reference in the resource-wrapped values. * Update doc/destructors.rst Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* ORC: support for custom =trace procs (#18459)Andreas Rumpf2021-07-092-3/+39
| | | | | | | | | | | * ORC: support custom =trace procs (WIP) * Update tests/arc/tcustomtrace.nim Co-authored-by: Clyybber <darkmine956@gmail.com> * =trace is now documented and seems to work * make test green Co-authored-by: Clyybber <darkmine956@gmail.com>
* ORC: use =destroy instead of =dispose (#18440)Andreas Rumpf2021-07-071-1/+1
| | | | | | * ORC refactoring in preparation for further changes (=dispose must die) * ORC: embrace =destroy, avoid =dispose * ORC: no need for =dispose * closes #18421
* Add commas to docs for clarity (#18398)Elliot Waite2021-06-291-1/+1
|
* Peg captures get stack-like behavior (#18369)gemath2021-06-281-3/+7
| | | | | * Implements reverse capture indexing. * Now works for modified backrefs too. * Changed reverse indexing syntax prefix for back-references to '$^'.
* Switch packaging.rst to use makefileFederico Ceratto2021-06-271-3/+4
| | | Minor cleanup
* add multi type exception catching to manual (#18258) (#18323)xioren2021-06-211-4/+2
|
* close #17403; improve docs for tuple (#18312)Timothee Cour2021-06-211-7/+8
|
* followup #17852, disallow all:on for now (#18311)Timothee Cour2021-06-201-1/+2
|
* support `--hint:all:off --hint:x` (ditto with `--warnings` + friends) (#17852)Timothee Cour2021-06-201-7/+8
| | | | | * select all hints via `--hint:all:on|off`, etc * simplify code with setutils * address comment
* move {.injectStmt.} to experimental; add a test (#18300)Timothee Cour2021-06-202-11/+1
| | | | | * move {.injectStmt.} to experimental; add a test * undocument and deprecat `.injectStmt` but keep its implementation until we have a replacement
* Make the existence of high(type) clearer, especially near subranges (#18286)j-james2021-06-181-4/+7
| | | | | * Make the existence of high(type) clearer, especially around subranges * Use a better example and dry up the wording
* merge BuildMode into SuccessX, remove code duplication w drnim, add useful ↵Timothee Cour2021-06-141-1/+0
| | | | | | | | | | | info to successx, add gc to compilesettings (#18252) * merge BuildMode into SuccessX, add more info * refactor duplicated with drnim * fixup * address comment
* view types: spec changes (#18226)Andreas Rumpf2021-06-101-17/+14
| | | | | | | | | | | | | * view types: spec changes * Update doc/manual_experimental.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/manual_experimental.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
* Update nims.rst to reflect that -d:release is now allowed in config.nims ↵Kaushal Modi2021-06-101-6/+6
| | | | | (#18221) `-d:release` and `-d:danger` started working in `config.nims` after https://github.com/nim-lang/Nim/commit/df429fa28772e077faa30dd6e3a701abf48c7669 .
* update docgen documentation (#18192)Andrey Makarov2021-06-062-48/+76
| | | | | | | | | | | | | * update docgen documentation * --fullhelp * Update doc/docgen.rst Co-authored-by: Timothee Cour <timothee.cour2@gmail.com> * [skip ci] fix typos Co-authored-by: Timothee Cour <timothee.cour2@gmail.com>
* follow-up #18013 - inline syntax highlighting (#18166)Andrey Makarov2021-06-0420-164/+183
|
* fixes #18058 (#18162)Andreas Rumpf2021-06-031-0/+2
|
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2025-07-17 08:10:31 +0000