Nim/doc
Alexander Ivanov 672dc5cd87
Nil type check implementation (#15287)
* Nil checking
* Enable current older not nil checking again, run new checking only under flag, skip our test
* Enable tests, work on try/except and bugs, fix notnil tests

* Enable strictNotNil tests (currently with lowercase category) and add some expected output
* Work on try/except/finally: still some things unclear and a lot of code can raise out of try
* Fix the notnil build by going back to the old version of a test which I shouldn't have changed

* Fix test : use action compile
* Work on mutation and aliasing: not finished
* Render var parititions graph, try to understand it, fix a nilcheck if bug
* Rebase, progress on working with partitions
* Improve time logic
* Fix some bugs, use graph indices instead of symbol in nil map
* Fix bugs, test simpler ident aliasing for now, support two mutation levels
* Support ContentMutation and ReAssignment: for now just detect possible re assignment for var parameters of calls
* Enable several simple passing tests
* Cleanup a bit, fix condition/branch infix-related bug
* Remove some files, address some comments by Araq
* Use internalError and no quit for now
* Separate tests with expected warnings and with expected ok, fix a bug with if with a single branch related to copyMap
* Fix new data structures, bugs: make tests pass, disable some for now
* Work on fixing errors with non-sym nodes, aliasing: tests fail
* Work on alias support: simple set-based logic, todo more tests and ref sets?
* Use ref sets: TODO can we think of handle seq-s similar to varpartitions' Araq ones
* Handle defers in one place, stop raising in reverse to make an async test compile with strictNotNil, add a commented out test
* Dot expressions: call/reassignment. Other refactorings and distinct, SeqOfDistinct support. Checkout an older varpartitions
* Work on field tracking
* Backup : trying to fix bugs when running some stdlib stuff for running an async test
* Start a section about strict not nil checking in experimental manual
* Fix experimental strict not nil manual section and move it to another file based on Araq feedback
* Fix unstructured flow and double warning problems, fix manual, cleanup
* Fix if/elif/else : take in account structure according to Araq feedback
* Refactor a bit
* Work on bracket expr support, re-enable tests, clarify in manual/tests/implementation static index support for now
* Work on compiling stdlib and compiler with strictNotNil
* Small fixes to the manual for strictNotNil
* Fix idgen for strict check nil rebase
* Enable some simple tests, remove old stuff, comment out code/print
* Copy the original varpartitions source instead of my changes
* Remove some files
2020-12-29 10:31:11 +01:00
..
manual Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
advopt.txt remove all mentions of doc2, jsondoc2 (except 1 mentioning the alias) (#15683) 2020-11-26 11:54:18 -08:00
apis.rst Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
astspec.txt Add docs for nnkHiddenStdConv (#16408) 2020-12-27 10:45:30 +01:00
backends.rst Add note about minimum Node.js version (#16370) 2020-12-16 16:05:59 +00:00
basicopt.txt new: nim -e:cmd to run a command directly; also fixes #15731 (#15687) 2020-11-09 16:07:22 +01:00
contributing.rst Don't use unittest.suite and unittest.test (#16464) 2020-12-27 10:15:57 +01:00
destructors.rst include example of error-marked copy proc (#15886) 2020-11-09 11:45:43 +01:00
docgen.rst Fix broken links in docs (#16336) 2020-12-14 20:13:12 +01:00
docgen_sample.nim fix #13218: avoid some irrelevant warnings for nim doc,rst2html,--app:lib, + other fixes (#13550) 2020-03-13 20:42:41 +01:00
docs.rst Documentation update a description (#14619) 2020-06-09 22:17:32 +01:00
docstyle.rst remove all mentions of doc2, jsondoc2 (except 1 mentioning the alias) (#15683) 2020-11-26 11:54:18 -08:00
drnim.rst Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
effects.txt Nimrod renamed to Nim 2014-08-28 22:36:14 +02:00
estp.rst renamed most remaining .txt documentation files to .rst 2016-06-07 04:04:49 +02:00
filelist.txt Fix Typos in Internal Docs (#11735) [ci skip] 2019-07-15 19:05:23 +02:00
filters.rst fix #9647 tmpl=>nimf (#9658) 2018-11-14 08:27:48 +01:00
gc.rst Spelling and Grammer fixes (#15719) 2020-10-28 17:56:56 +01:00
grammar.txt implements https://github.com/nim-lang/RFCs/issues/258 (#15503) 2020-10-06 16:47:15 +02:00
hcr.rst Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
idetools.rst Fix some typos (#14843) 2020-06-28 19:17:18 +02:00
intern.rst Syntax (RST) fix Internals of the Compiler (#16341) 2020-12-15 14:57:11 +01:00
keywords.txt language change: 'generic' and 'atomic' are not keywords anymore 2017-11-21 11:27:35 +01:00
koch.rst Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
lib.rst remove iup from stdlib in contrast to #15828 (#15830) 2020-11-03 20:43:51 +01:00
manual.rst removing out T from docs since it no longer working (#16378) [backport] 2020-12-18 10:40:43 +01:00
manual_experimental.rst Nil type check implementation (#15287) 2020-12-29 10:31:11 +01:00
manual_experimental_strictnotnil.rst Nil type check implementation (#15287) 2020-12-29 10:31:11 +01:00
mytest.cfg '#' value parcing is explained (disambiguated) (#12476) 2019-10-25 15:22:26 +02:00
nep1.rst RST tables: fix latex col number; allow less than three of = (#16040) 2020-12-04 08:50:17 +01:00
nimc.rst remove all mentions of doc2, jsondoc2 (except 1 mentioning the alias) (#15683) 2020-11-26 11:54:18 -08:00
nimdoc.css RST: implement admonitions (#16438) 2020-12-27 11:16:12 +01: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 Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
nims.rst Documentation update nims.rst (#14683) 2020-06-17 07:58:03 +02:00
nimsuggest.rst Fix word wrapping 2019-10-22 17:59:12 -07:00
overview.rst further cleanups; refs #4934 2016-10-24 12:20:51 +02:00
packaging.rst [backport] Add links to packaging and distro pages (#12603) [ci skip] 2019-11-06 09:03:28 +01:00
pegdocs.txt doc: Trim .txt files trailing whitespace 2015-09-04 23:10:48 +02:00
prelude.rst Documentation prelude (#15377) 2020-09-21 12:37:14 +02:00
readme.txt doc: Trim .txt files trailing whitespace 2015-09-04 23:10:48 +02:00
regexprs.txt fixed article duplication typos (#16216) 2020-12-02 09:15:29 +01:00
sets_fragment.txt Fix many broken links 2019-10-22 17:59:12 -07:00
spawn.txt renames threadpool.await to blockUntil; refs #7853 2018-08-14 01:28:04 +02:00
subexes.txt more "eg" fixes 2020-10-20 10:51:50 +02:00
testament.rst testament: error instead of silently ignore invalid targets; remove pointless alias target vs targets; document matrix; DRY (#16343) 2020-12-14 10:58:29 +01:00
tools.rst Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
tut1.rst Fix broken links in docs (#16336) 2020-12-14 20:13:12 +01:00
tut2.rst remove all mentions of doc2, jsondoc2 (except 1 mentioning the alias) (#15683) 2020-11-26 11:54:18 -08:00
tut3.rst Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00

============================
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!