summary refs log tree commit diff stats
path: root/doc/manual.rst
Commit message (Collapse)AuthorAgeFilesLines
* make `from` an operator (#14241)hlaaftana2020-05-081-16/+16
|
* exp. features now in correct manual, closes #11932 (#14195)hlaaftana2020-05-021-167/+3
|
* discardable async procs are now an error (#14176)hlaaftana2020-05-011-1/+2
| | | | * add discard warning in manual
* Error -> Defect for defects (#13908)Jacek Sieka2020-04-281-14/+14
| | | | | | | | | | | | | | * Error -> Defect for defects The distinction between Error and Defect is subjective, context-dependent and somewhat arbitrary, so when looking at an exception, it's hard to guess what it is - this happens often when looking at a `raises` list _without_ opening the corresponding definition and digging through layers of inheritance. With the help of a little consistency in naming, it's at least possible to start disentangling the two error types and the standard lib can set a good example here.
* changed type() to typeof() in docs and error messages (#14084)hlaaftana2020-04-241-1/+1
|
* docs: move `not nil` to the experimental page (#14027)Rory O’Kane2020-04-211-26/+0
| | | | | When I heard that this feature existed, and found the 2018 changelog entry that said `not nil` was made experimental (https://github.com/nim-lang/Nim/blob/devel/changelogs/changelog_0_19_0.md#changes-affecting-backwards-compatibility), I looked for `not nil` documentation in https://nim-lang.org/docs/manual_experimental.html. When I didn’t find it there, I initially assumed the feature had no documentation. This change moves the documentation to where readers will expect it. As well as moving the text to another file, I added instructions for enabling the experimental feature and tweaked some wording.
* clarify tuples and objects in manual, fixes #12486 (#14044)hlaaftana2020-04-211-7/+20
|
* Small typo (#13824)Clyybber2020-03-311-1/+1
|
* macros for proc types, macros for types (#13778)Andreas Rumpf2020-03-311-44/+74
| | | | | | | | | * new minor feature: macros for proc types, to be documented * Finished the implementation and added tests * [skip ci] Describe the new custom pragmas in the manual and the changelog Co-authored-by: Zahary Karadjov <zahary@gmail.com>
* docs: say that `nil` can be used as a value (#13756)Rory O’Kane2020-03-251-5/+8
| | | | | and improve wording in other ways Showing that `nil` can be assigned helps to warn readers that variables can be `nil` even after being assigned a value.
* catchable defects (#13626)Andreas Rumpf2020-03-121-13/+21
| | | | | | | | | | * allow defects to be caught even for --exceptions:goto (WIP) * implemented the new --panics:on|off switch; refs https://github.com/nim-lang/RFCs/issues/180 * new implementation for integer overflow checking * produce a warning if a user-defined exception type inherits from Exception directly * applied Timothee's suggestions; improved the documentation and replace the term 'checked runtime check' by 'panic' * fixes #13627 * don't inherit from Exception directly
* fix #13409: Document as infix operator (#13570)hlaaftana2020-03-041-16/+16
|
* Document import/include outside of top level semantics (#13548)hlaaftana2020-03-011-0/+14
|
* Fixed non-working examples in Manual: Exception Handling (#13424)Manav2020-02-201-1/+3
|
* manual: documents changes regarding dynlib (#13425)alaviss2020-02-181-4/+4
| | | | | | | | * manual: documents changes regarding dynlib Closes #13416 * manual: clean up sentence phrasing
* fixes #3339 by documenting the limitations of case-statement (#13366)Miran2020-02-081-0/+29
|
* fixes #10665 (#13141) [backport]Andreas Rumpf2020-01-141-0/+3
|
* docs: tiny style improvementsAraq2019-12-241-2/+2
|
* update documentation for `closureScope` and `capture` (#12886)Judd2019-12-211-1/+2
|
* ARC: cycle detector (#12823)Andreas Rumpf2019-12-171-2/+26
| | | | | | | | | | | | | * 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
* 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.
* deviated -> derived (#12845) [backport]Mark2019-12-081-1/+1
|
* [backport] Fix spelling typos (#12755)Brian Wignall2019-11-281-5/+5
|
* 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
|
* 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
* 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.
* [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-241-12/+14
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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-221-8/+9
| |
| * 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.
| * Fix many broken linksJjp1372019-10-221-7/+8
| | | | | | | | | | | | 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.
* | fixes #12453 (#12475)Arne Döring2019-10-231-0/+19
|/
* Fixes #10824 (#12437)Juan Carlos2019-10-171-0/+19
|
* Fix #10804 (#12438)Juan Carlos2019-10-171-4/+4
|
* [backport] Mention "lambdas" and `=>` in the manual (#12397) [ci skip]awr12019-10-101-3/+5
| | | (so that "lambda" can be CTRL+F'd)
* Fixed sizeOf to sizeof (#12347)Ridho Pratama2019-10-031-1/+1
|
* Explicitly state that trailing underscores are banned (#12257)Mathias Stearn2019-09-251-2/+5
| | | It was explicit in the BNF, but the English text implied it was allowed.
* importjs symbol (#12218)Arne Döring2019-09-201-6/+15
| | | | | * importjs symbol * importjs warning message, minor warning fixes
* allows access to .compileTime vars at runtime (#12128)Andreas Rumpf2019-09-051-0/+25
|
* Fix int literals and range interaction (#11197)Oscar Nihlgård2019-08-311-5/+6
| | | | | | | | * Fix int literals and range interaction * Fix test * remove float range fix; update changelog
* fixes #12029; finish the 'unused import' feature (#12064)Andreas Rumpf2019-08-271-0/+11
|
* manual: more precise rules about evaluation orderAraq2019-08-271-0/+38
|
* manual: better documentation for implicit genericsAndreas Rumpf2019-08-261-18/+82
|
* new gensym handling (#11985)Andreas Rumpf2019-08-231-0/+39
| | | | | | | | | | | * new .gensym implementation * make astspec test green again * introduce a --useVersion switch to group compatibility switches * fixes #10180 * fixes #11494 * fixes #11483 * object constructor fields and named parameters are also not gensym'ed * disabled broken package
* Consider range type of runtime discrim [feature] (#11432)Oscar Nihlgård2019-08-201-1/+7
|
* added destructors.rst spec to the build documentationAraq2019-08-161-0/+4
|
* Incremental compilation (IC): Improvements (#11881)Andreas Rumpf2019-08-081-2/+2
| | | | | | | | | | | | | | | | | | | * IC: C codegen is aware of IC * manual: minor change to make VSCode's RST plugin render it properly * IC: minor refactoring * testament: code refactorings * rodutils: removed dead code * IC: always build the compiler with the IC feature * IC: C codegen improvements * IC: implement the undocumented -d:nimMustCache option for testing purposes * IC: added first basic tests * IC: extensive testing of the deserialization feature * testament: refactoring; better IC tests * IC: removes 'nimMustCache' flag; readonly does the same * testament: minor refactoring * update Nimble version * testament: removed dead code and imports; IC: added simple test * IC: progress