mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-01-03 03:32:32 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2e880c726b0072bec93e897e5caef8f5bbe3d6b6
Nim/doc
History
Timothee Cour 2b30998159 document that multiple yield in inline iterator cause code bloat (#10553) 
* document that multiple `yield` in inline iterator cause code duplication
* doc: rule `Start types with a capital T` was deprecated
2019-02-05 13:05:26 +01:00
..
manual
improve documentation for 'var T return values'; refs #7373
2018-04-21 17:01:33 +02:00
advopt.txt
Added --docInternal option to allow 'nim doc' to include non-exported symbols
2019-01-23 11:09:26 +01:00
apis.rst
integrate 'koch web' features into koch; deprecate 'nimweb' tool
2018-09-13 18:47:53 +02:00
astspec.txt
Fixed a wrong AST example (#8269)
2018-07-11 08:52:09 +02:00
backends.rst
fix outdated example to invoke Nim from C
2018-11-27 15:44:03 -05:00
basicopt.txt
compiler interface: don't overdocument the on|off switches
2019-01-22 11:45:45 +01:00
codeowners.rst
Fixes #9671 (#9750)
2018-11-19 09:22:21 +01:00
contributing.rst
add git diff hints to help with reviews (#10435)
2019-01-28 07:10:20 +01:00
docgen_sample.nim
Transforms docgen sample to be generated from source.
2014-01-06 14:55:03 +01:00
docgen.rst
docs: fix trailing comma in links
2019-01-25 09:43:47 +01:00
docs.rst
Add link to tutorial part III to docs.rst (#10157) [ci skip]
2019-01-01 19:49:29 +01:00
docstyle.rst
further cleanups; refs #4934
2016-10-24 12:20:51 +02:00
effects.txt
Nimrod renamed to Nim
2014-08-28 22:36:14 +02:00
endb.rst
Removed space between "array" and a square bracket in the docs
2018-05-19 20:28:27 +03:00
estp.rst
renamed most remaining .txt documentation files to .rst
2016-06-07 04:04:49 +02:00
filelist.txt
fixes #2559
2015-09-10 10:50:29 +02:00
filters.rst
fix #9647 tmpl=>nimf (#9658)
2018-11-14 08:27:48 +01:00
gc.rst
docs for the heap dump feature
2017-01-16 23:04:53 +01:00
grammar.txt
parser/grammar sync; fixes #9608 [backport]
2018-11-07 20:07:43 +01:00
idetools.rst
renamed most remaining .txt documentation files to .rst
2016-06-07 04:04:49 +02:00
intern.rst
document that multiple yield in inline iterator cause code bloat (#10553)
2019-02-05 13:05:26 +01:00
keywords.txt
language change: 'generic' and 'atomic' are not keywords anymore
2017-11-21 11:27:35 +01:00
koch.rst
Testament pre parallel (#9137)
2018-10-12 17:27:47 +02:00
lib.rst
Cleanup heapqueue module (#10476)
2019-01-28 09:58:37 +01:00
manual.rst
document that multiple yield in inline iterator cause code bloat (#10553)
2019-02-05 13:05:26 +01:00
mytest.cfg
docs: document that --flag is same as flag in cfg config files (#8430)
2018-07-30 10:17:41 +02:00
nep1.rst
add the apis.txt table to nep1.rst
2018-07-09 12:35:25 +02:00
nimc.rst
Increase verbosity of logGC (#10449)
2019-01-26 12:26:36 +01:00
nimdoc.css
Add NEP1 to documentation.
2015-07-10 03:51:00 -04:00
nimfix.rst
renamed most remaining .txt documentation files to .rst
2016-06-07 04:04:49 +02:00
nimgrep.rst
renamed most remaining .txt documentation files to .rst
2016-06-07 04:04:49 +02:00
niminst.rst
renamed most remaining .txt documentation files to .rst
2016-06-07 04:04:49 +02:00
nims.rst
setCommand nop update documentation (#10254)
2019-01-13 09:04:40 +01:00
nimsuggest.rst
Revert "nimsuggest somehow transforms \n into \\x0A, not \x0A"
2018-11-01 14:29:18 -07:00
overview.rst
further cleanups; refs #4934
2016-10-24 12:20:51 +02:00
packaging.rst
fix #10287 (#10448)
2019-01-25 08:34:02 +01:00
pegdocs.txt
doc: Trim .txt files trailing whitespace
2015-09-04 23:10:48 +02:00
readme.txt
doc: Trim .txt files trailing whitespace
2015-09-04 23:10:48 +02:00
regexprs.txt
fixes #9471 (#10502)
2019-01-30 19:49:09 +01:00
sets_fragment.txt
Tut 1: tiny improvements
2018-02-05 21:13:18 +01:00
spawn.txt
renames threadpool.await to blockUntil; refs #7853
2018-08-14 01:28:04 +02:00
subexes.txt
s/advanted/advanced/g
2015-09-20 18:16:51 -07:00
tools.rst
more documentation improvements; fixes #9119
2018-09-29 20:10:44 +02:00
tut1.rst
Tutorial 1: Simplifiy the discription of enums; it is a tutorial, not a manual
2018-08-31 00:30:19 +02:00
tut2.rst
added a new macro tutorial (#9588)
2018-11-21 15:46:58 +01:00
tut3.rst
tut3.rst formatting fix
2019-02-04 14:31:52 +01:00

readme.txt 

============================
Nim's documenation system
============================

This folder contains Nim's documentation. The documentation
is written in a format called *reStructuredText*, a markup language that reads
like ASCII and can be converted to HTML automatically!