summary refs log tree commit diff stats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* lib.rst: add a link for jsconsole [backport] (#13383)Jjp1372020-02-111-0/+3
|
* fixes #3339 by documenting the limitations of case-statement (#13366)Miran2020-02-081-0/+29
|
* fix #13150 `nim doc --project` now works reliably (#13223)Timothee Cour2020-02-061-0/+7
| | | | | | | | | | * fix #13150 `nim doc --project` works with duplicate names and with imports below main project file * add to help; fixup after #13212 isRelativeTo got merged * fix test tests/compilerapi/tcompilerapi.nim * remove nimblePkg field; compute on the fly instead * kochdocs: compiler docs now under compiler/ * --docRoot now has smart default: best among @pkg, @path
* contributing.rst: Add a special rule for 'outplace'-like featuresAraq2020-02-051-2/+15
|
* contributing docs: symbols need package prefix; changed allocStats to ↵Timothee Cour2020-01-251-0/+14
| | | | nimAllocStats (#13247)
* Updated 'nim for embedded systems' section to use --os:any and --gc:arc (#13237)Ico Doornekamp2020-01-231-15/+33
| | | | | | * Updated 'nim for embedded systems' section to use --os:any and --gc:arc * Added section about size optimization to embedded systems
* VM: allow overriding MaxLoopIterations without rebuilding nim (#13233)Timothee Cour2020-01-231-0/+1
|
* [backport] Documentation Fix #12251 (#13226) [ci skip]Juan Carlos2020-01-221-0/+8
|
* followup on #10435 : should be diff, not show (#13162)Timothee Cour2020-01-171-1/+1
|
* make sink operator optional (#13068)cooldome2020-01-171-2/+6
| | | | | | | | | | | | | | | | * make sink operator optional * bug fix, add changelog entry * Trigger build * fix one regression * fix test * Trigger build * fix typos
* Fix typo in doc/destructors.rst (#13148)Tomohiro2020-01-141-1/+1
|
* fixes #10665 (#13141) [backport]Andreas Rumpf2020-01-142-23/+28
|
* [easy] --hint:link:on now shows link cmd instead of nothing (#13056)Timothee Cour2020-01-071-1/+2
| | | | | | * --hint:link:on now shows link cmd instead of nothing * update doc for --listCmd
* Fix typo (#13015) [backport]Siegfried Ehret2020-01-031-1/+1
|
* --exception:goto switch for deterministic exception handling (#12977)Andreas Rumpf2020-01-011-1/+2
| | | | | This implements "deterministic" exception handling for Nim based on goto instead of setjmp. This means raising an exception is much cheaper than in C++'s table based implementations. Supports hard realtime systems. Default for --gc:arc and the C target because it's generally a good idea and arc is all about deterministic behavior. Note: This implies that fatal runtime traps are not catchable anymore! This needs to be documented.
* [ci skip] docfix .. < => ..< (#12981) [backport]Timothee Cour2019-12-291-1/+1
|
* added guidelines for evolving Nim's stdlibAraq2019-12-241-0/+62
|
* docs: tiny style improvementsAraq2019-12-242-2/+3
|
* update documentation for `closureScope` and `capture` (#12886)Judd2019-12-211-1/+2
|
* ARC: cycle detector (#12823)Andreas Rumpf2019-12-172-6/+30
| | | | | | | | | | | | | * first implementation of the =trace and =dispose hooks for the cycle collector * a cycle collector for ARC: progress * manual: the .acyclic pragma is a thing once again * gcbench: adaptations for --gc:arc * enable valgrind tests for the strutils tests * testament: better valgrind support * ARC refactoring: growable jumpstacks * ARC cycle detector: non-recursive algorithm * moved and renamed core/ files back to system/ * refactoring: --gc:arc vs --gc:orc since 'orc' is even more experimental and we want to ship --gc:arc soonish
* Add `--git.devel` option to the documentationBinHong Lee2019-12-151-0/+4
|
* feature dracula themed doc (#12816)Andreas Rumpf2019-12-101-214/+800
| | | | | | | | | | * Implement gorgeous Dracula themed Nim documentation * Add color for escape sequences * fixes the test cases * the big CSS cleanup
* Manual update: custom exceptions (#12847) [backport]Mark2019-12-081-0/+17
| | | Said that you can have custom exceptions and showed how to create and raise them.
* Removing the mention of using `discard` for block comments (#12837) [backport]Elliot Waite2019-12-081-3/+0
| | | | | | * Remove mention of using `discard` for block comments * Add a 32x32 alternate favicon
* deviated -> derived (#12846) [backport]Mark2019-12-081-3/+3
|
* deviated -> derived (#12845) [backport]Mark2019-12-081-1/+1
|
* [backport] Fix spelling typos (#12755)Brian Wignall2019-11-283-9/+9
|
* fix typo in the manual (#12723)tauplus2019-11-251-1/+1
|
* Fix wrong section hierarchy in the manual (#12724) [backport]tauplus2019-11-251-9/+9
|
* implemented a new localPassc pragma (#12706)Andreas Rumpf2019-11-221-4/+17
|
* added the --asm command line option for inspection of the produced assember ↵Andreas Rumpf2019-11-211-0/+1
| | | | code (#12699)
* conversions to unsigned numbers are not checked anymore; implements /… ↵Andreas Rumpf2019-11-201-0/+14
| | | | | | | | (#12688) [backport] * conversions to unsigned numbers are not checked anymore; implements / fixes https://github.com/nim-lang/RFCs/issues/175 * change the spec yet again to be less consistent but to make more sense; updated the changelog
* Discussion both in (#12678)c-blake2019-11-201-0/+1
| | | | | | | | | | | https://github.com/nim-lang/Nim/pull/12600 and in https://forum.nim-lang.org/t/5499 indicates that everyone is happy/happier with ``pop``. This just renames the brand new ``take``s to ``pop`` and installs inline aliases/wrappers to preserve ``Table.take`` and ``TableRef.take``. Update apis.rst to try to maintain consistency of remove-and-return procs.
* fixes and changes the recently introduced 'alignas' to be 'align' (#12666)Andreas Rumpf2019-11-151-13/+14
| | | | | | * fixes and changes the recently introduced 'alignas' to be 'align' * more improvements
* implemented alignas pragma (#12643)Arne Döring2019-11-131-0/+32
| | | | | | | | | | | | * implemented alignas pragma * fix bootstrap * generate c++ compatible syntax for alignas * Make it work. * Multiple alignof expressions. Implement top level alignof.
* add --clearNimblePath; fixes #12601 (#12609)Andy Davidoff2019-11-061-0/+1
|
* [backport] doc/tut3.rst: Fix typo in Introduction (#12607) [ci skip]Tor Arvid Lund2019-11-061-1/+1
| | | Derivative of `b*pow(x, 2)` is `2*b*x`, while old version had `2*a*x`
* [backport] Add links to packaging and distro pages (#12603) [ci skip]Federico Ceratto2019-11-062-0/+4
|
* fix several typos in documentation and comments (#12553)Nindaleth2019-10-301-1/+1
|
* destructors.rst: added a missing 'var' to the motivating exampleAraq2019-10-281-1/+1
|
* [backport] fix broken link to non-existing c2nim manual html, fixes #12537 ↵Anthon van der Neut2019-10-281-1/+1
| | | | [ci skip] (#12544)
* integer literal documentation [ci skip] (#12513)Arne Döring2019-10-281-0/+88
| | | | | | * integer literal documentation [ci skip] * apply feedback [ci skip]
* Remove sentences referring to the graphics module (#12522)Jjp1372019-10-261-2/+1
|
* '#' value parcing is explained (disambiguated) (#12476)Artem V L2019-10-251-1/+2
|
* [backport] Add link to posix_utils.html - related to #10723 (#12509)Federico Ceratto2019-10-241-1/+2
|
* [backport] Clarifies experimental / parallel example on manual.rst (#12472)UNIcodeX2019-10-241-1/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Clarifies experimental / parallel on manual.rst Details: Calling `useParallel()` in example fails with compiler error Error: 'parallel' section without 'spawn' Adding `spawn` causes error: Error: internal error: (filename: "ccgexprs.nim", line: 1032, column: 17) No stack traceback available To create a stacktrace, rerun compilation with ./koch temp c <file> Therefore a separate proc, `threadedEcho`, is added for the echo'ing of the string, which allows the example to build, however, `sync()` must be added so that the "echo in parallel" strings will actually be shown on the terminal. Otherwise, the program will spawn of the threads and exit before they can return to the main thread. * Fixes and clarifies example for threading in manual.rst Issue: Calling useParallel() in example failed with compiler error `Error: 'parallel' section without 'spawn'` Adding spawn yielded compiler error: ```bash Error: internal error: (filename: "ccgexprs.nim", line: 1032, column: 17) No stack traceback available To create a stacktrace, rerun compilation with ./koch temp c ``` Proposed Solution: - Separate proc, threadedEcho, is added for the echo'ing of the string, which allows the example to build - Added the thread number so that it can demonstrate that sometimes threads which were started sooner, come back after threads which were started later.
* Fix many broken links and prefer relative links within docs (#12463)Miran2019-10-2415-125/+138
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Fix many broken links Note that contrary to what docgen.rst currently says, the ids have to match exactly or else most web browsers will not jump to the intended symbol. * Prefer relative links for Nim documentation This is more friendly to those browsing the documentation without a network connection. The nim-doc package in Debian allows this, for example. Also, the domain name being used was not consistent. It could have been either nim-lang.org or nim-lang.github.io, and those reading the stable docs could have found themselves suddenly reading the devel docs instead. * koch.rst: remove link to nonexistent section * manual.rst: remove unintended link cast[T](0) is interpreted as a link to id 0 with text T, so escape the opening parentheses to display the intended output. * asyncstreams: replace unintended link with emphasis * Fix word wrapping
| * Fix word wrappingJjp1372019-10-2211-87/+98
| |
| * manual.rst: remove unintended linkJjp1372019-10-221-1/+1
| | | | | | | | | | cast[T](0) is interpreted as a link to id 0 with text T, so escape the opening parentheses to display the intended output.
| * koch.rst: remove link to nonexistent sectionJjp1372019-10-221-1/+1
| |