summary refs log tree commit diff stats
path: root/doc/destructors.md
Commit message (Collapse)AuthorAgeFilesLines
* destructors: better docs [backport:2.0] (#22391)Andreas Rumpf2023-08-051-28/+57
|
* fixes #22174; fixes destructor examples (#22349)ringabout2023-07-311-6/+6
| | | | | | | | | | | * fixes #22174; fixes destructor examples * Update doc/destructors.md Co-authored-by: Andreas Rumpf <rumpf_a@web.de> --------- Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* destructors: update, =destroy does not require a 'var T' (#22168)Andreas Rumpf2023-06-271-3/+3
|
* allow destructors to accept non var parameters; deprecate `proc =destroy(x: ↵ringabout2023-06-211-6/+6
| | | | | | | | | | var T)` (#22130) * make destructors accept non var parameters * define nimAllowNonVarDestructor * add a test case and a changelog * update documentation and error messages * deprecate destructors taking 'var T'
* Fix indentation in destructors.md (#22048)Antonis Geralis2023-06-081-1/+1
|
* update the documentation of the dup hook (#21984)ringabout2023-06-031-2/+12
| | | | | | | | | | | | | | | | | | | | | * update the documentation of the dup hook * document `=dup` * typo * minor improvement * typo * Update doc/destructors.md * Update doc/destructors.md * Update doc/destructors.md --------- Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* adds documentation for `=wasMoved` and `=dup` hooks and small fixes (#21827)ringabout2023-05-111-1/+36
| | | | | | | | | | | * 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>
* fixes #21245; warn about destructors that can raise (#21726)Andreas Rumpf2023-04-261-3/+11
| | | | | | | | | * fixes #21245; warn about destructors that can raise * doc update * progress * typo
* Markdown indented code blocks (#20473)Andrey Makarov2022-10-051-35/+34
| | | | | | | | | | | | | | | | | | | | | | | * 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
* Markdown links migration part 1 (#20319)Andrey Makarov2022-09-091-1/+2
| | | | | | | | | | | | | 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)
* Markdown code blocks part 3 (#20117)Andrey Makarov2022-08-041-57/+46
| | | No logic was added, just 4 more files migrated.
* Improve Markdown code blocks & start moving docs to Markdown style (#19954)Andrey Makarov2022-07-151-0/+730
- add additional parameters parsing (other implementations will just ignore them). E.g. if in RST we have: .. code:: nim :test: "nim c $1" ... then in Markdown that will be: ```nim test="nim c $1" ... ``` - implement Markdown interpretation of additional indentation which is less than 4 spaces (>=4 spaces is a code block but it's not implemented yet). RST interpretes it as quoted block, for Markdown it's just normal paragraphs. - add separate `md2html` and `md2tex` commands. This is to separate Markdown behavior in cases when it diverges w.r.t. RST significantly — most conspicously like in the case of additional indentation above, and also currently the contradicting inline rule of Markdown is also turned on only in `md2html` and `md2tex`. **Rationale:** mixing Markdown and RST arbitrarily is a way to nowhere, we need to provide a way to fix the particular behavior. Note that still all commands have **both** Markdown and RST features **enabled**. In this PR `*.nim` files can be processed only in Markdown mode, while `md2html` is for `*.md` files and `rst2html` for `*.rst` files. - rename `*.rst` files to `.*md` as our current default behavior is already Markdown-ish - convert code blocks in `docgen.rst` to Markdown style as an example. Other code blocks will be converted in the follow-up PRs - fix indentation inside Markdown code blocks — additional indentation is preserved there - allow more than 3 backticks open/close blocks (tildas \~ are still not allowed to avoid conflict with RST adornment headings) see also https://github.com/nim-lang/RFCs/issues/355 - better error messages - (other) fix a bug that admonitions cannot be used in sandbox mode; fix annoying warning on line 2711