summary refs log tree commit diff stats
path: root/doc/manual
Commit message (Expand)AuthorAgeFilesLines
* deviated -> derived (#12846) [backport]Mark2019-12-081-3/+3
* improve documentation for 'var T return values'; refs #7373Andreas Rumpf2018-04-211-0/+20
* merge the different manual/*.rst include files. Was too hard to find the corr...Andreas Rumpf2018-04-1424-8010/+0
* Cpp codegen: handling of imported exceptions. Fixes #3571 (#7360)cooldome2018-04-101-0/+22
* added the 'x.p[:T]' notation for explicit generic instantiations in combinati...Araq2018-04-063-37/+38
* fix small typo in the documentation (#7411)Abhishek2018-03-261-2/+2
* Fix #7304 by clarifying integer width in manual (#7319)twetzel592018-03-171-2/+4
* fixes #7247Andreas Rumpf2018-02-231-26/+0
* fixes the RST in the manualAndreas Rumpf2018-02-041-1/+1
* Merge branch 'devel' into araq-overloading-symmetryAndreas Rumpf2018-02-031-3/+3
|\
| * manual: do not mention the VTable types which are not implemented yetAndreas Rumpf2018-02-021-44/+45
| * Fix the names of the float checks pragmas. (#7170)konqoro2018-02-011-3/+3
* | better type inference for numerical types; prerequisitive for version 1Andreas Rumpf2018-02-021-0/+29
* | manual: do not mention the VTable types which are not implemented yetAndreas Rumpf2018-02-021-44/+45
|/
* fixes #7089Andreas Rumpf2018-01-241-4/+6
* Mention lack of js support in closure iterator limitations (#7110)Mathias Stearn2018-01-191-0/+1
* Implement custom annotations (#6987)cooldome2018-01-091-0/+67
* Add compile-time paragraph to manualZach Smith2017-12-301-0/+4
* manual: clarify the rules for integer literalsAraq2017-12-271-1/+2
* language change: change how the experimental dot operators workAndreas Rumpf2017-11-291-3/+3
* Documentation: directly use ref object + fields (#6598)Mamy Ratsimbazafy2017-11-153-25/+40
* Merge branch 'devel' into araqAndreas Rumpf2017-11-071-1/+1
|\
| * fix broken link in manual (#6697)Kartik Saranathan2017-11-061-1/+1
* | Merge branch 'devel' into araqAndreas Rumpf2017-11-0211-25/+67
|\|
| * breaking change: 'and' and 'mod' do not produce a subrange type anymore; fixe...Andreas Rumpf2017-10-301-19/+0
| * new feature: package level objectsAndreas Rumpf2017-10-291-0/+38
| * Tweeks in the manual (#6599)narimiran2017-10-2610-20/+24
| * fix broken linknarimiran2017-10-231-1/+1
| * Constants can contain objects (excluding object variants)Daniil Yarancev2017-10-161-1/+1
| * minor update of the manualAraq2017-10-161-3/+3
* | Merge branch 'devel' into araqAndreas Rumpf2017-10-023-6/+7
|\|
| * the 'using construct is not .experimental anymoreAraq2017-09-301-4/+0
| * documentation improvement; make mixin easier to search (#6409)jlp7652017-09-211-0/+6
| * Update docs on assignment operator (#6373)superfunc2017-09-151-2/+1
* | Merge branch 'araq' of github.com:nim-lang/Nim into araqAndreas Rumpf2017-09-151-20/+0
|\ \ | |/ |/|
| * Merge branch 'devel' into araqAndreas Rumpf2017-09-153-8/+12
| |\
| * | no interval arithmetic anymore to construct implicit range types; breaking ch...Andreas Rumpf2017-07-131-20/+0
* | | Corrected manual (Identifier equality) (#6366)GULPF2017-09-111-3/+3
| |/ |/|
* | update the manual; 'of', 'low' and 'high' can now be overloadedAndreas Rumpf2017-09-011-2/+2
* | remove ArrayDummySize with unchecked arrays (#5818)Jacek Sieka2017-08-281-5/+1
* | Replaced en-dash with hyphen for identifier equality (#6272)Fredrik Høisæther Rasch2017-08-241-1/+1
* | Restore the old behavior of parsing "quote do:"Zahary Karadjov2017-08-191-0/+8
|/
* Update pragmas.txt (#6006)Dan2017-06-211-2/+23
* fix affecting templates with explicit generic paramsZahary Karadjov2017-05-131-2/+2
* manual additions for the covariant generic parametersZahary Karadjov2017-05-121-2/+87
* explain covariance in the manualZahary Karadjov2017-05-121-0/+16
* object construction: test cases and manual additionsZahary Karadjov2017-04-061-1/+3
* News items for previous commitZahary Karadjov2017-04-061-3/+3
* remove the need for the .procvar annotationAndreas Rumpf2017-04-031-10/+0
* remove en-dash from the languageAndreas Rumpf2017-04-021-2/+1
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2025-02-03 08:47:15 +0000
e line following the ``proc`` definition, and is prefixed by ``##`` on each line. Code examples are also encouraged. The RestructuredText Nim uses has a special syntax for including examples. .. code-block:: nim proc someproc*(): string = ## Return "something" ## ## .. code-block:: nim ## ## echo someproc() # "something" result = "something" # single-hash comments do not produce documentation The ``.. code-block:: nim`` followed by a newline and an indentation instructs the ``nim doc`` and ``nim doc2`` commands to produce syntax-highlighted example code with the documentation. When forward declaration is used, the documentation should be included with the first appearance of the proc. .. code-block:: nim proc hello*(): string ## Put documentation here proc nothing() = discard proc hello*(): string = ## Ignore this echo "hello" The preferred documentation style is to begin with a capital letter and use the imperative (command) form. That is, between: .. code-block:: nim proc hello*(): string = # Return "hello" result = "hello" or .. code-block:: nim proc hello*(): string = # says hello result = "hello" the first is preferred. The Git stuff ============= General commit rules -------------------- 1. All changes introduced by the commit (diff lines) must be related to the subject of the commit. If you change some other unrelated to the subject parts of the file, because your editor reformatted automatically the code or whatever different reason, this should be excluded from the commit. *Tip:* Never commit everything as is using ``git commit -a``, but review carefully your changes with ``git add -p``. 2. Changes should not introduce any trailing whitespace. Always check your changes for whitespace errors using ``git diff --check`` or add following ``pre-commit`` hook: .. code-block:: sh #!/bin/sh git diff --check --cached || exit $? 3. Describe your commit and use your common sense. .. include:: docstyle.rst
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2025-02-03 08:47:12 +0000