summary refs log tree commit diff stats
path: root/doc/manual.md
Commit message (Collapse)AuthorAgeFilesLines
* fixes a typo in the manual (#22383)ringabout2023-08-041-1/+1
| | | ref https://github.com/nim-lang/Nim/commit/0d3bde95f578576d2e84d422d5694ee0e0055cbc#commitcomment-122093273
* Document `cast` zeroing memory (#22313)konsumlamm2023-07-221-14/+17
|
* Adding info to manual (#22252)Ryan McConnell2023-07-191-3/+57
| | | | | | | | | | | * Adjustments * Moving example * typo * adding code example back and fix terms * Condensing
* clean up the documentation (#22196)ringabout2023-07-021-5/+3
|
* fixes #19086: Document exception and defect hierarchy (#22030)Raynei2023-06-081-0/+32
| | | | | * Documented exception and defect hierarchy (#19086) * Fixed style
* documents changes on byref and bycopy (#21882)Juan M Gómez2023-05-221-6/+10
|
* isolation spec update; WIP (#21843)Andreas Rumpf2023-05-141-6/+4
| | | | | | | | | | | * isolation spec update; WIP * wip * docs update, WIP * progress * Update doc/manual.md
* adds documentation for `=wasMoved` and `=dup` hooks and small fixes (#21827)ringabout2023-05-111-1/+1
| | | | | | | | | | | * adds documentation for `=wasMoved` and `=dup` hooks and small fixes * Update doc/destructors.md * Update doc/destructors.md --------- Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* Remove LineTooLong (#21819)Juan Carlos2023-05-111-10/+10
| | | | | | | * LineTooLong refactor to make it actually useful * Improve error message * changelog wording * Fix typo
* fixes links of generic `define` pragma (#21828)ringabout2023-05-111-1/+1
|
* documents codegendecl for object types (#21811)Juan M Gómez2023-05-081-2/+25
|
* Document about size pragma (#21794)Tomohiro2023-05-061-0/+31
| | | | | | | | | | | | | * Document about size pragma * Fix typos * Fix manual.md * Update doc/manual.md --------- Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* Update the Nim Manual compile pragma with the second tuple form (#21773)Daniel Belmes2023-05-051-0/+6
| | | | | * Update the nim manual compile pragma with the second tuple form of * Incorrectly put 'two' forms
* documents #21628 (#21723)Juan M Gómez2023-04-241-0/+29
| | | | | | | | | * documents #21628 * Update doc/manual.md --------- Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* Documented path substitution by compiler (#21662)Raynei2023-04-211-0/+2
| | | Document compiler path substitution (nim-lang#19928)
* `proc` typeclass accounts for `iterator`, call conventions + `nil` fix + ↵metagn2023-04-111-1/+12
| | | | | | | | | | | | | document typeclass AST (#21629) * test fix #16546 #16548 + another issue * please don't tell me other packages do this * fix CI + test typeclass callconv pragma * better logic in parser * docs and changelog
* warn against `a, b = val` in routine arguments (#21604)metagn2023-04-061-9/+0
| | | closes https://github.com/nim-lang/RFCs/issues/480
* document general use of `_`, error message, fixes (#21584)metagn2023-03-301-0/+13
| | | | | | | | | | | | * document general use of `_`, error message, fixes fixes #20687, fixes #21435 Documentation and changelog updated to clarify new universal behavior of `_`. Also new error message for attempting to use `_`, new tests, and fixes with overloadable symbols and implicit generics. * add test for #21435
* tuple unpacking for vars as just sugar, allowing nesting (#21563)metagn2023-03-281-2/+31
| | | | | | | | | | | | | | | | | | | * tuple unpacking for vars as just sugar, allowing nesting * set temp symbol AST * hopeful fix some issues, add test for #19364 * always use temp for consts * document, fix small issue * fix manual indentation * actually fix manual * use helper proc * don't resem temp tuple assignment
* closes #21536; fixes manual (#21552)ringabout2023-03-201-2/+2
| | | fixes manual
* fixes #19291; implements `wasMoved` hook (#21303)ringabout2023-03-021-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * fixes #19291; implements `wasMoved` hook * basics * checkpoint * finish `wasMoved` * add a test for #19291 * add documentation and changelog * work `attachedWasMoved` with generics * fixes optimizer * register `=wasMoved` * handle wasMoved magcis * check another round * some patches * try `op == nil` * nicer * generate `wasMoved` before `destroy` * try again * fixes tests * default wasMoved * Update tests/destructor/tv2_cast.nim * Update tests/destructor/tv2_cast.nim * Update tests/arc/topt_refcursors.nim
* Fix a couple of small keyword issues. (#21416)Benji York2023-02-221-2/+2
| | | In this section of the manual, "if" should be enclosed in backticks and "elif" should be lower case.
* fix #19580; add warning for bare except: clause (#21099)ringabout2022-12-151-11/+9
| | | | | | | | | | | | | | | | | | | | | * fix #19580; add warning for bare except: clause * fixes some easy ones * Update doc/manual.md * fixes docs * Update changelog.md * addition * Apply suggestions from code review Co-authored-by: Jacek Sieka <arnetheduck@gmail.com> * Update doc/tut2.md Co-authored-by: Jacek Sieka <arnetheduck@gmail.com>
* generic `define` pragma + string alias (#20979)metagn2022-12-131-0/+18
| | | | | | | | | * generic `define` pragma + string alias * clean * add tests and document * remove char/float, minimize changelog
* clean up the documentation of threads (#21067)ringabout2022-12-101-12/+1
| | | | | * clean up the documentation of threads * cleanup
* better procvar ambiguity errors, clean up after #20457 (#20932)metagn2022-12-011-0/+17
| | | | | | | | | | | | | | | * better procvar ambiguity errors, clean up after #20457 fixes #6359, fixes #13849 * only trigger on closedsymchoice again * new approach * add manual entry for ambiguous enums too * add indent [skip ci] * move to proc
* add documentation and changelog for default object fields (#20845)ringabout2022-11-151-0/+51
|
* add back discard as a way to do multiline comments, see #12352 (#20688)Pietro Peterlongo2022-10-281-0/+12
|
* fixes #19162; enable `strictEffects` for v2 (#19380)ringabout2022-10-151-3/+1
| | | | | | | | | | | | | | | | | | | * enable stricteffects * add gcsafe * fix tests * use func * fixes pegs tests * explicitly mark repr related procs with noSideEffect * add nimLegacyEffects * change URL * fixes docopt * add `raises: []` to repr * fixes weave * fixes nimyaml * fixes glob * fixes parsetoml * Apply suggestions from code review * Update testament/important_packages.nim * add legacy:laxEffects
* Automatic dereferencing is removed (#20531)ringabout2022-10-101-4/+0
|
* Markdown indented code blocks (#20473)Andrey Makarov2022-10-051-70/+76
| | | | | | | | | | | | | | | | | | | | | | | * Implement Markdown indented code blocks Additional indentation of 4 spaces makes a block an "indented code block" (monospaced text without syntax highlighting). Also `::` RST syntax for code blocks is disabled. So instead of ```rst see:: Some code ``` the code block should be written as ```markdown see: Some code ``` * Migrate RST literal blocks :: to Markdown's ones
* Unicode Operators are no longer experimental (#20444)ringabout2022-09-281-0/+15
| | | | | | | | | * Unicode Operators are no longer experimental * fixes tests * Update doc/manual.md Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* moderate system cleanup & refactor (#20355)metagn2022-09-281-11/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * system refactor, move out 600 lines * compilation, slice, backwardsindex, misc_num moved out of system * some procs/types moved into arithmetics, basic_types * system no longer depends on syncio * some procs moved around to fit with their surroundings * make exceptions an import, old ops to misc_num * move instantiationInfo back * move back nim version, fix windows echo * include compilation * better docs for imported modules, fix unsigned ops also remove ze, ze64, toU8, toU16, toU32 with nimPreviewSlimSystem * fix terminal * workaround IC test & weird csize bug, changelog * move NimMajor etc back to compilation, rebase for CI * try ic fix * form single `indices`, slim out TaintedString, try fix IC * fix CI, update changelog, addQuitProc * fix CI * try fix CI * actually fix CI finally hopefully * Update lib/system/compilation.nim Co-authored-by: ringabout <43030857+ringabout@users.noreply.github.com> * update kochdocs * hopefully fix csize uses for slimsystem * fix tquit Co-authored-by: ringabout <43030857+ringabout@users.noreply.github.com>
* Update manual.md (#20394)Judd2022-09-211-17/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | * Update manual.md update outdated information on `ObservableStores`. * Update manual.md add `base` pragma to fix the warning. * Update doc/manual.md accept. Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com> * Update manual.md update example code. * Update manual.md 1. more updates to help keeping readers on track. 1. fix typos. Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com>
* more minor updates to manual.md (#20360)Judd2022-09-151-5/+5
| | | | | | | | | | * fix typos in manual.md 1. remove redundant `(` 1. 'System module' -> 'system module'. * Update manual.md "However" is not easy to understand. Suggest changing to the word into "In this version" to make the comparison explicite.
* minor improvements to follow up recent PRs (#20342)metagn2022-09-141-0/+32
| | | | | | put mOpenArrayToSeq in compile-time evaluation whitelist (it was mNone before which was whitelisted), homogenize "ordinal type expected" errors, put overloadable enums in non-experimental manual
* Replace word 'param(s)' with 'parameter(s)'. (#20331)random-bites2022-09-111-16/+16
| | | Replace word 'params(s)' with 'parameter(s)'.
* Implement Markdown definition lists (+ migration) (#20333)Andrey Makarov2022-09-111-16/+16
| | | | | | | | | | | | | | | Implements definition lists Markdown extension adopted in a few implementations including: * [Pandoc]( https://pandoc.org/MANUAL.html#definition-lists) * [kramdown]( https://kramdown.gettalong.org/quickref.html#definition-lists) * [PHP extra Markdown]( https://michelf.ca/projects/php-markdown/extra/#def-list) Also affected files have been migrated. RST definition lists are turned off for Markdown: this solves the problem of broken formatting mentioned in https://github.com/nim-lang/Nim/pull/20292.
* Markdown links migration part 1 (#20319)Andrey Makarov2022-09-091-77/+71
| | | | | | | | | | | | | Markdown link migration part 1 Also the warning is improved a bit. Local links (targeting inside its document) which had had a full anchor were turned into concise form. The very fact that they existed may be due to the bug in reference to subsections fixed https://github.com/nim-lang/Nim/pull/20279, now they are working well (both in RST syntax and new Pandoc Markdown syntax implemented in https://github.com/nim-lang/Nim/pull/20304)
* update manual (#20325)Judd2022-09-091-2/+4
| | | | 1. remove two redundant `.`; 1. add information on format string for `importc` just as `exportc`
* Update manual.md (#20321)Judd2022-09-081-3/+5
| | | | | | | | | * Update manual.md add explanation for $#. * Update manual.md add explanation.
* Implement Pandoc Markdown concise link extension (#20304)Andrey Makarov2022-09-041-4/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Implement Pandoc Markdown concise link extension This implements https://github.com/nim-lang/Nim/issues/20127. Besides reference to headings we also support doing references to Nim symbols inside Nim modules. Markdown: ``` Some heading ------------ Ref. [Some heading]. ``` Nim: ``` proc someFunction*() ... ... ## Ref. [someFunction] ``` This is substitution for RST syntax like `` `target`_ ``. All 3 syntax variants of extension from Pandoc Markdown are supported: `[target]`, `[target][]`, `[description][target]`. This PR also fixes clashes in existing files, particularly conflicts with RST footnote feature, which does not work with this PR (but there is a plan to adopt a popular [Markdown footnote extension](https://pandoc.org/MANUAL.html#footnotes) to make footnotes work). Also the PR fixes a bug that Markdown links did not work when `[...]` section had a line break. The implementation is straightforward since link resolution did not change w.r.t. RST implementation, it's almost only about new syntax addition. The only essential difference is a possibility to add a custom link description: form `[description][target]` which does not have an RST equivalent. * fix nim 1.0 gotcha
* remove deprecated type pragma syntax, fix bugs that required it (#20199)metagn2022-09-031-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | * remove deprecated pragma syntax from 0.20.0 closes #4651, closes #16653 with a cheap fix for now due to how early `tfFinal` is set * remove type pragma between name and generics * undo removal, try removing bind expression (0.8.14) * fix test, unremove bind expr * remove again * Update changelog.md Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * dependencies @ HEAD & weave test dependencies * try fix package ci Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
* support cstring in `case` (#20130)metagn2022-09-011-0/+5
| | | | | | | | | | | | | | | * implement case for cstring for now just converts to string on C backend * custom implementation for cstring * remove leftover * revert even more * add nil + fix packages weird variant literal bug * update docs
* minor updates on manual (#20258)Judd2022-08-271-11/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * minor updates on manual 1. statement -> keyword: 1. re-phase on the explanation of `import except`: maybe the newer version does not export some of the identifiers; 1. "The original module name is then not accessible" is moved up to the previous paragraph, since it is coupled with the previous paragraph, but not the current one. 1. re-phase on the explanation of _Disabling certain messages_. * Apply suggestions from code review Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com> * Update manual.md do not use "()". * Update doc/manual.md Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com> Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> Co-authored-by: ringabout <43030857+ringabout@users.noreply.github.com> Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com>
* Update manual.md (#20277)Clay Sweetser2022-08-261-3/+2
|
* remove unused sfProcvar, "procvar" mentions (#20204)metagn2022-08-241-2/+1
| | | refs #12975. doesn't close it because wProcvar isn't removed
* new .redefine pragma for templates, warn on redefinition without it (#20211)metagn2022-08-231-0/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * test CI for template redefinitions * adapt asyncmacro * fix quote * fix again * try something else * revert * fix ioselectors_select, disable packages CI * adapt more tests & simplify * more * more * more * rename to redefine, warn on implicit redefinition * basic documentation [skip ci] * Update compiler/lineinfos.nim Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com> Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
* fixes manual regression (#20259)ringabout2022-08-231-0/+2
| | | ref https://github.com/nim-lang/Nim/pull/20080
* Markdown code blocks part 5 (#20236)Andrey Makarov2022-08-171-7/+8
| | | No logic was added, just a few more `*.md` files have been migrated.
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2025-07-23 08:11:52 +0000