summary refs log tree commit diff stats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* complete std prefixes for stdlib (#22887)ringabout2023-10-305-12/+12
| | | | follow up https://github.com/nim-lang/Nim/pull/22851 follow up https://github.com/nim-lang/Nim/pull/22873
* fixes #22867; fixes cstring modification example on Nim Manual (#22871)ringabout2023-10-261-1/+2
| | | fixes #22867
* doc: fix typos (#22869)shuoer862023-10-254-5/+5
| | | doc: fix typos
* adds support for noDecl in constructor (#22811)Juan M Gómez2023-10-111-1/+1
| | | Notice the test wouldnt link before
* marking a field with noInit allows to skip constructor initialiser (#22802)Juan M Gómez2023-10-081-0/+50
| | | Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* Fix typo/grammar in exception tracking section (#22801)Levi Notik2023-10-071-1/+1
| | | | | | | | I came across this sentence in the Nim Manual and couldn't make sense of it. I believe this is the correct fix for the sentence. --------- Co-authored-by: ringabout <43030857+ringabout@users.noreply.github.com>
* docs: add another switch example for nimscript (#22772)daylin2023-09-301-0/+2
| | | | | I couldn't find any documentation on the syntax for --hint:X:on|off with `nimscript` except in [this old forum post](https://forum.nim-lang.org/t/8526#55236).
* Make `typeRel` behave to spec (#22261)Ryan McConnell2023-09-301-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | The goal of this PR is to make `typeRel` accurate to it's definition for generics: ``` # 3) When used with two type classes, it will check whether the types # matching the first type class (aOrig) are a strict subset of the types matching # the other (f). This allows us to compare the signatures of generic procs in # order to give preferrence to the most specific one: ``` I don't want this PR to break any code, and I want to preserve all of Nims current behaviors. I think that making this more accurate will help serve as ground work for the future. It may not be possible to not break anything but this is my attempt. So that it is understood, this code was part of another PR (#22143) but that problem statement only needed this change by extension. It's more organized to split two problems into two PRs and this issue, being non-breaking, should be a more immediate improvement. --------- Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* Documentation only (#22760)Juan Carlos2023-09-271-12/+12
| | | | - Documentation only. - Sometimes newbies try to use Valgrind with RefC etc.
* Documentation only (#22761)Juan Carlos2023-09-271-0/+4
| | | - Mention Bisect bot in Bisect documentation.
* Documentation only (#22735)Juan Carlos2023-09-211-12/+13
| | | - Add Atomic ARC to Documentation. Documentation only, tiny diff.
* removes references to `this` in the `constructor` section (#22730)Juan M Gómez2023-09-201-4/+3
|
* Document C++ Initializers (#22704)Juan M Gómez2023-09-151-0/+27
| | | Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* docgen: add Pandoc footnotes (fixes #21080) (#22591)Andrey Makarov2023-09-033-13/+15
| | | | | | | | | | This implements Pandoc Markdown-style footnotes, that are compatible with Pandoc referencing syntax: Ref. [^ftn]. [^ftn]: Block. See https://pandoc.org/MANUAL.html#footnotes for more examples.
* type annotations for variable tuple unpacking, better error messages (#22611)metagn2023-09-011-1/+1
| | | | | | | | | * type annotations for variable tuple unpacking, better error messages closes #17989, closes https://github.com/nim-lang/RFCs/issues/339 * update grammar * fix test
* fix #22492 (#22511)Hamid Bluri2023-08-221-5/+6
| | | | | | | | | | | | | | | | | | | | | | | | | * fix #22492 * Update nimdoc.css remove scroll-y * Update nimdoc.out.css * Update nimdoc.css * make it sticky again * Update nimdoc.out.css * danm sticky, use fixed * Update nimdoc.out.css * fix margin * Update nimdoc.out.css * make search input react to any change (not just keyboard events) according to https://github.com/nim-lang/Nim/pull/22511#issuecomment-1685218787
* #22514 expand testament option docs (#22516)PhilippMDoerner2023-08-191-6/+55
| | | | | | | | | | | | | | | | | | * #22514 Expand docs on testament spec options The file, line and column options of testament are not in the docs, but can be very important to know. They allow you to specify where a compile-time error originated from. Particularly given that testament assumes the origin to always be the test-file, this is important to know. * #22514 Specify nimout relevance a bit more * #22514 Fix slightly erroneous doc-link * #22514 Add example * #22514 Add some docs on ccodecheck
* updates manual with codegenDecl on params docs (#22333)Juan M Gómez2023-08-171-3/+2
| | | | | | | | | | | | * documents member * Update doc/manual_experimental.md Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com> --------- Co-authored-by: Andreas Rumpf <rumpf_a@web.de> Co-authored-by: Clay Sweetser <Varriount@users.noreply.github.com>
* documents member (#22460)Juan M Gómez2023-08-121-0/+59
| | | | | | | | | | | | | | | | | | | | | | | | * documents member * Apply suggestions from code review Co-authored-by: Juan Carlos <juancarlospaco@gmail.com> * Update doc/manual_experimental.md * Update doc/manual_experimental.md * Update doc/manual_experimental.md * Update doc/manual_experimental.md * Update doc/manual_experimental.md * Update doc/manual_experimental.md --------- Co-authored-by: Juan Carlos <juancarlospaco@gmail.com> Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* unify starting blank lines in the experimental manual (#22396)ringabout2023-08-061-23/+0
| | | unify starting blank lines in the experimental manal
* Stick search result (#22394)Bung2023-08-061-1/+7
| | | | | | | | | * nimdoc: stick search result inside browser viewport * fix nimdoc.out.css --------- Co-authored-by: Locria Cyber <74560659+locriacyber@users.noreply.github.com>
* destructors: better docs [backport:2.0] (#22391)Andreas Rumpf2023-08-051-28/+57
|
* fixes a typo in the manual (#22383)ringabout2023-08-041-1/+1
| | | ref https://github.com/nim-lang/Nim/commit/0d3bde95f578576d2e84d422d5694ee0e0055cbc#commitcomment-122093273
* Add experimental inferGenericTypes switch (#22317)SirOlaf2023-08-031-0/+81
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Infer generic bindings * Simple test * Add t * Allow it to work for templates too * Fix some builds by putting bindings in a template * Fix builtins * Slightly more exotic seq test * Test value-based generics using array * Pass expectedType into buildBindings * Put buildBindings into a proc * Manual entry * Remove leftover ` * Improve language used in the manual * Experimental flag and fix basic constructors * Tiny commend cleanup * Move to experimental manual * Use 'kind' so tuples continue to fail like before * Explicitly disallow tuples * Table test and document tuples * Test type reduction * Disable inferGenericTypes check for CI tests * Remove tuple info in manual * Always reduce types. Testing CI * Fixes * Ignore tyGenericInst * Prevent binding already bound generic params * tyUncheckedArray * Few more types * Update manual and check for flag again * Update tests/generics/treturn_inference.nim * var candidate, remove flag check again for CI * Enable check once more --------- Co-authored-by: SirOlaf <> Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* 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>
* Fix grammar top rule (#22325)Khaled Hammouda2023-07-241-1/+1
| | | change stmt to complexOrSimpleStmt in the top grammar rule
* implemented 'push quirky' switch for fine grained control over the ex… ↵Andreas Rumpf2023-07-232-11/+74
| | | | | | | (#22318) * implemented 'push quirky' switch for fine grained control over the exception handling overhead * documentation
* 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-0210-20/+14
|
* Tidy contributing.md: format cmd (#22204)心夏❤v2023-07-011-2/+2
|
* docs nimBasePattern (#22179)Juan M Gómez2023-06-281-0/+2
|
* 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'
* better docs; undocument sinkInference as it doesn't work (#22089)Andreas Rumpf2023-06-132-10/+8
|
* make binary `not` not parse complex expressions on right side (#22078)metagn2023-06-121-3/+3
| | | | | | | * binary `not` only parses simple expressions fixes #16324 * switch to primary
* Atlas: now in its own repository (#22066)Andreas Rumpf2023-06-101-188/+0
| | | | | * Atlas: now in its own repository * progress
* Remove Deprecated Nimfix (#22062)Juan Carlos2023-06-102-68/+3
| | | | * Remove Deprecated Nimfix * Trailing whitespace cleanups
* fixes typos in the constructor docs (#22035)Juan M Gómez2023-06-091-3/+3
| | | | | | | | | | | * fixes typos in the constructor docs * updates constructor docs * Update doc/manual_experimental.md --------- Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* Fix indentation in destructors.md (#22048)Antonis Geralis2023-06-081-1/+1
|
* fixes #19086: Document exception and defect hierarchy (#22030)Raynei2023-06-081-0/+32
| | | | | * Documented exception and defect hierarchy (#19086) * Fixed style
* documents constructor (#22013)Juan M Gómez2023-06-061-0/+58
| | | | | | | | | * documents constructor * Apply suggestions from code review --------- Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
* post expr blocks colon fix + correct grammar (#21983)metagn2023-06-061-11/+15
| | | | | | | | | | | | | | | * post expr blocks colon fix + correct grammar fixes #21982 * fix dochelpers * this is remarkably common * use head for unchained * fix atlas * final grammar fix
* 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>
* Atlas: virtual environments (#21965)Andreas Rumpf2023-05-301-0/+15
| | | | | * Atlas: virtual environments * fixes
* Atlas: URL rewrite rules; --autoinit flag (#21963)Andreas Rumpf2023-05-301-0/+37
|
* Atlas: some final cleanups (#21947)Andreas Rumpf2023-05-282-14/+10
|
* ship atlas and build documentation (#21945)ringabout2023-05-282-0/+144
| | | | | * ship atlas and build documentation * move atlas.md and link it in tools' index
* fix #21501 by making --app:lib and --app:staticLib imply --noMain (#21910)heterodoxic2023-05-261-1/+1
|
* documents changes on byref and bycopy (#21882)Juan M Gómez2023-05-221-6/+10
|
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2025-02-10 13:49:08 +0000