Nim/doc
Lancer11211 efd5c571bf
.forbids pragma: defining forbidden tags (#20050)
* .forbids pragma: defining illegal effects for proc types

This patch intends to define the opposite of the .tags pragma: a way to define effects which are not allowed in a proc.

* updated documentation and changelogs for the forbids pragma

* renamed notTagEffects to forbiddenEffects

* corrected issues of forbids pragma

the forbids pragma didn't handle simple restrictions properly and it also had issues with subtyping

* removed incorrect character from changelog

* added test to cover the interaction of methods and the forbids pragma

* covering the interaction of the tags and forbids pragmas

* updated manual about the forbids pragma

* removed useless statement

* corrected the subtyping of proc types using the forbids pragma

* updated manual for the forbids pragma

* updated documentations for forbids pragma

* updated nim docs

* updated docs with rsttester.nim

* regenerated documentation

* updated rst docs

* Update changelog.md

Co-authored-by: ringabout <43030857+ringabout@users.noreply.github.com>

* updated changelog

* corrected typo

Co-authored-by: ringabout <43030857+ringabout@users.noreply.github.com>
2022-07-26 07:40:49 +02:00
..
manual Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
advopt.txt Fixed description as option in advopt.txt (#19635) 2022-03-26 09:56:10 +01:00
apis.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
astspec.txt RST: improve simple tables (#19859) 2022-06-04 07:03:03 +02:00
backends.md Markdown code blocks part 2; migrate Nim Manual (#20080) 2022-07-25 18:29:52 +02:00
basicopt.txt basicopt.txt: Unify the format (#19251) 2021-12-14 09:54:01 +01:00
contributing.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
destructors.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
docgen.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02: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.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
docstyle.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
drnim.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
effects.txt Nimrod renamed to Nim 2014-08-28 22:36:14 +02:00
estp.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
filelist.txt follow-up #17837: add Console for interactive sessions (#17930) 2021-05-06 10:58:01 +02:00
filters.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
grammar.txt Allow full commands and blocks in type sections (#19181) 2022-01-02 07:29:55 +01:00
hcr.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
idetools.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
intern.md Fix typo in line 456 (#20047) 2022-07-17 00:00:28 +02:00
keywords.txt language change: 'generic' and 'atomic' are not keywords anymore 2017-11-21 11:27:35 +01:00
koch.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
lib.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
manual.md .forbids pragma: defining forbidden tags (#20050) 2022-07-26 07:40:49 +02:00
manual_experimental.md Markdown code blocks part 2; migrate Nim Manual (#20080) 2022-07-25 18:29:52 +02:00
manual_experimental_strictnotnil.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
mm.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
mytest.cfg '#' value parcing is explained (disambiguated) (#12476) 2019-10-25 15:22:26 +02:00
nep1.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
nimc.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
nimdoc.cls RST: improve simple tables (#19859) 2022-06-04 07:03:03 +02:00
nimdoc.css Keep the doc sidebar on the screen while scrolling (#19851) 2022-06-15 15:40:56 +02:00
nimfix.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
nimgrep.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
nimgrep_cmdline.txt update nimgrep documentation (#17415) 2021-03-23 18:12:27 +01:00
niminst.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
nims.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
nimsuggest.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
overview.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
packaging.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
pegdocs.txt Peg captures get stack-like behavior (#18369) 2021-06-28 12:33:20 +02:00
readme.txt doc: Trim .txt files trailing whitespace 2015-09-04 23:10:48 +02:00
refc.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
regexprs.txt follow-up #18013 - inline syntax highlighting (#18166) 2021-06-04 16:16:51 +02:00
rstcommon.rst follow-up #17692: more inline syntax highlighting (#17837) 2021-04-29 17:16:14 +02:00
sets_fragment.txt Markdown code blocks part 2; migrate Nim Manual (#20080) 2022-07-25 18:29:52 +02:00
spawn.txt Change stdlib imports to use std prefix in most examples (#17202) 2021-02-28 13:17:19 -08:00
subexes.txt more "eg" fixes 2020-10-20 10:51:50 +02:00
testament.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
tools.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
tut1.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
tut2.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02:00
tut3.md Improve Markdown code blocks & start moving docs to Markdown style (#19954) 2022-07-15 19:27:54 +02: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!