summary refs log tree commit diff stats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* New/better macro pragmas, mark some as experimental (#19406)metagn2022-01-202-17/+83
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * New/better macro pragmas, make some experimental fix #15920, close #18212, close #14781, close #6696, close https://github.com/nim-lang/RFCs/issues/220 Variable macro pragmas have been changed to only take a unary section node. They can now also be applied in sections with multiple variables, as well as `const` sections. They also accept arguments. Templates now support macro pragmas, mirroring other routine types. Type and variable macro pragmas have been made experimental. Symbols without parentheses instatiating nullary macros or templates has also been documented in the experimental manual. A check for a redefinition error based on the left hand side of variable definitions when using variable macro pragmas was disabled. This nerfs `byaddr` specifically, however this has been documented as a consequence of the experimental features `byaddr` uses. Given how simple these changes are I'm worried if I'm missing something. * accomodate compiler boot * allow weird pragmas * add test for #10994 * remove some control flow, try remove some logic
* deprecate unsafeAddr; extend addr (#19373)flywind2022-01-162-11/+6
| | | | | | | | | | | | | | | | | | | | | | | | | * deprecate unsafeAddr; extend addr addr is now available for all addressable locations, unsafeAddr is deprecated and become an alias for addr * follow @Vindaar's advice * change the signature of addr * unsafeAddr => addr (stdlib) * Update changelog.md * unsafeAddr => addr (tests) * Revert "unsafeAddr => addr (stdlib)" This reverts commit ab83c99c507048a8396e636bf22d55fdd84d7d1c. * doc changes; thanks to @konsumlamm Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
* move type operation section and remove deepcopy document (#19389)flywind2022-01-152-40/+26
| | | ref #19173; because deepcopy is not fit for ORC/ARC which was used for spawn and spawn will be removed from compiler
* docs: Mention `import foo {.all.}` syntax (#19377)Leon2022-01-131-0/+11
| | | | | | | Mention the `import foo {.all.}` syntax in the manual, with a caveat about private imports. Also link to the experimental importutils module. Co-authored-by: adigitoleo <adigitoleo@dissimulo.com>
* docs: Fix typo in tut1.rst (#19324)Nan Xiao2022-01-041-1/+1
|
* docs: Fix typo in tut1.rst (#19309)Nan Xiao2022-01-031-1/+1
|
* Allow full commands and blocks in type sections (#19181)hlaaftana2022-01-021-2/+3
| | | | | | | * allow full commands and blocks in type sections * update grammar * fix changelog [skip ci] * more tests * even more tests
* Update manual.rst (#19301)rockcavera2022-01-011-1/+1
|
* nep1: make header reflect reality (#19294)Andreas Rumpf2021-12-291-3/+3
|
* fixes grammar typos [backport] (#19289)Andreas Rumpf2021-12-271-3/+3
|
* Fixed typo in manual.rst unsafeAssign->uncheckedAssign. Fixes part 1 of ↵Don-Duong Quach2021-12-171-1/+1
| | | | #19266 (#19267)
* basicopt.txt: Unify the format (#19251)Nan Xiao2021-12-141-2/+2
|
* nimc.rst: fix table markup (#19239)Ștefan Talpalaru2021-12-111-0/+2
|
* added --nimMainPrefix switch; fixes #15955; refs #16945 [backport:1.6] (#19235)Andreas Rumpf2021-12-103-0/+12
|
* nimRawSetjmp: support Windows (#19197)Ștefan Talpalaru2021-12-101-0/+14
| | | | | | | | | | | | * nimRawSetjmp: support Windows Using `_setjmp()` directly is required to avoid some rare (but very annoying) exception-related stack corruption leading to segfaults on Windows, with Mingw-w64 and SEH. More details: https://github.com/status-im/nimbus-eth2/issues/3121 Also add "nimBuiltinSetjmp" - mostly for benchmarking. * fix for Apple's Clang++
* the title of PR should contain a brief description (#19211)flywind2021-12-061-0/+3
| | | In addition to an issue number, the title of a PR should contain a brief description; then users can follow the progress more easily from the title.
* treat do with pragmas but no parens as proc (#19191)hlaaftana2021-12-051-4/+4
| | | fixes #19188
* Improve documentation around func and method (#19207)PMunch2021-12-041-2/+29
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Improve documentation around func and method * Update doc/tut1.rst Co-authored-by: Danil Yarantsev <tiberiumk12@gmail.com> * Update doc/tut1.rst Co-authored-by: Danil Yarantsev <tiberiumk12@gmail.com> * Update doc/tut1.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: Zoom <ZoomRmc@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: Zoom <ZoomRmc@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: Zoom <ZoomRmc@users.noreply.github.com> * Update doc/tut1.rst Co-authored-by: Zoom <ZoomRmc@users.noreply.github.com> * Rewrite of Zooms suggestion * Update doc/tut1.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> Co-authored-by: Danil Yarantsev <tiberiumk12@gmail.com> Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> Co-authored-by: Zoom <ZoomRmc@users.noreply.github.com>
* misc bugfixes [backport:1.2] (#19203)Andreas Rumpf2021-12-041-14/+9
|
* renamed 'gc' switch to 'mm'; [backport:1.6] (#19187)Andreas Rumpf2021-11-247-137/+150
| | | | * renamed 'gc' switch to 'mm'; [backport:1.6] * better docs
* `caseStmtMacros` no longer experimental, experimental manual refactor (#19173)hlaaftana2021-11-232-785/+808
| | | | | | | | | | | * `caseStmtMacros` no longer experimental, experimental manual refactor * Update doc/manual.rst * apply review suggestions * apply review Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* implement RST & Markdown quote blocks (#19147)Andrey Makarov2021-11-231-0/+5
| | | | | | | * implement RST & Markdown quote blocks * compile with nim 1.0 * Fix indentation
* Implement threads on Zephyr (#19156)Jaremy Creechley2021-11-231-0/+9
| | | | | | | | | | | | | | | | | | | * pthreads setup for zephyr - enable tweak stack size - update lib/system/threads.nim - Fix int/uint in casting pointer. * add documentation and tweak flag names * add documentation and tweak flag names * fix configuration flag names * fix configuration flag names * cleanup Co-authored-by: Jaremy Creechley <jaremy.creechley@panthalassa.com>
* Accept nnkTypeSection from typedef macro pragmas (#19168)hlaaftana2021-11-221-0/+1
|
* Enable customizing PageShift to set PageSize for embedded targets (#19129)Jaremy Creechley2021-11-161-0/+24
| | | | | | | | | | | | | | | | * Enable customizing PageSize (via PageShift). This enables adjusting PageSize for embedded targets without abusing cpu16. * copy nimPageXYZ settings for mmpaptest * add docs for Nim manual * add docs for Nim manual * docs tweaks Co-authored-by: Jaremy Creechley <jaremy.creechley@panthalassa.com>
* update manual (#19130) [backport]flywind2021-11-121-2/+2
|
* Call {.cursor.} a pragma. (#19116)treeform2021-11-101-8/+8
| | | | | | | | | | * Call {.cursor.} a pragma. Its hard to find .curser annotation while googling because all other things like it are called pragmas. See https://nim-lang.org/docs/manual.html#pragmas Also the . in front of the name makes it hard to find and search for. Can we just call it cursor pragma? * Small fix for comment.
* Deprecate `std/sharedlist` and `std/sharedtables` (#19112)konsumlamm2021-11-091-6/+0
|
* change os.nim doc links to new style (#19102)Andrey Makarov2021-11-081-0/+7
|
* manual: Document that comma propagates the default values of parameters (#19080)Kaushal Modi2021-11-031-1/+9
| | | | | | | | | | | | | * manual: Document that comma propagates the default values of parameters Fixes https://github.com/nim-lang/Nim/issues/15949. * Use the "bug #NNNN" comment syntax for consistency Ref: https://nim-lang.github.io/Nim/contributing.html#writing-tests-stdlib > Always refer to a GitHub issue using the following exact syntax: bug for tooling.
* manual: Document the use of `static` as a proc call (#19084)Kaushal Modi2021-11-031-0/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | * manual: Document the use of `static` as a proc call Also adds tests. Fixes https://github.com/nim-lang/Nim/issues/16987 . * Update doc/manual.rst Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Use the "bug #NNNN" comment syntax for consistency Ref: https://nim-lang.github.io/Nim/contributing.html#writing-tests-stdlib > Always refer to a GitHub issue using the following exact syntax: bug for tooling. * manual: Undocument usage of foo.static foo.static and foo.static() are not expected to work. Ref: https://github.com/nim-lang/Nim/pull/19084/files#r741203578 Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
* update numbers of lifetime-tracking hooks in doc/destructors.rst (#19088)Derek 呆2021-11-021-1/+1
|
* docgen: implement doc link resolution in current module (#18642)Andrey Makarov2021-10-282-0/+174
|
* fix a tiny code snippet formatting issue in `doc/constructors.rst`, again ↵Derek 呆2021-10-281-1/+1
| | | | (#19065)
* fix a tiny formating issue in doc/destructors.rst (#19058)Derek 呆2021-10-271-1/+1
|
* Document file changes that may be needed for add a new platform (#19055)quantimnot2021-10-261-0/+36
| | | Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
* feat: copy to clipboard (#18963)Abishek PY2021-10-221-1/+31
| | | | | | | | | | | * feat: copy to clipboard * fix: CI failure related issue * fix: CI failure issue * fix: copy to clipboard button bug * feat: copy pragmadots value to clipboard
* 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