mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-01-03 11:42:33 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
5fed1c05ce7ea9cbeb2b70bb8583e836c981abd4
Nim/doc
History
Kaushal Modi 5fed1c05ce manual: Document the use of static as a proc call (#19084) 
* manual: Document the use of `static` as a proc call

Also adds tests.

Fixes https://github.com/nim-lang/Nim/issues/16987 .

* Update doc/manual.rst

Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>

* Use the "bug #NNNN" comment syntax for consistency

Ref:
https://nim-lang.github.io/Nim/contributing.html#writing-tests-stdlib

> Always refer to a GitHub issue using the following exact syntax: bug
for tooling.

* manual: Undocument usage of foo.static

foo.static and foo.static() are not expected to work.

Ref: https://github.com/nim-lang/Nim/pull/19084/files#r741203578

Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
2021-11-03 06:48:30 +01:00
..
manual
turn on syntax highlighting in Manual & Tutorial (#17692)
2021-04-11 10:23:08 +02:00
advopt.txt
followup #17852, disallow all:on for now (#18311)
2021-06-20 22:49:14 +02:00
apis.rst
follow-up #17692: more inline syntax highlighting (#17837)
2021-04-29 17:16:14 +02:00
astspec.txt
fix deprecated example (#18721)
2021-08-21 08:22:00 +02:00
backends.rst
follow-up #17692: more inline syntax highlighting (#17837)
2021-04-29 17:16:14 +02: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
breaking changes policies (#18541)
2021-07-21 10:22:30 +02:00
destructors.rst
update numbers of lifetime-tracking hooks in doc/destructors.rst (#19088)
2021-11-02 08:55:50 +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
docgen.rst
docgen: implement doc link resolution in current module (#18642)
2021-10-28 19:20:52 +02:00
docs.rst
Documentation update a description (#14619)
2020-06-09 22:17:32 +01:00
docstyle.rst
add RST highlighting for command line / shells (also fixes #16858) (#17789)
2021-04-21 16:57:54 +02:00
drnim.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
effects.txt
Nimrod renamed to Nim
2014-08-28 22:36:14 +02:00
estp.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
filelist.txt
follow-up #17837: add Console for interactive sessions (#17930)
2021-05-06 10:58:01 +02:00
filters.rst
change --hint[X] => --hint:X in nim repo (avoids shell quoting issues) (#18085)
2021-05-26 09:51:48 +02:00
gc.rst
follow-up #17930 - inline syntax highlighting (#18013)
2021-05-16 23:55:14 +02:00
grammar.txt
formal grammar updates [backport:1.2] (#18803)
2021-09-04 19:52:57 +02:00
hcr.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
idetools.rst
RST backtick refactor (all *.rst except manual.rst and rst_examples.rst) (#17258)
2021-03-18 20:37:55 -07:00
intern.rst
Document file changes that may be needed for add a new platform (#19055)
2021-10-26 08:33:26 +02:00
keywords.txt
language change: 'generic' and 'atomic' are not keywords anymore
2017-11-21 11:27:35 +01:00
koch.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
lib.rst
Update lib.rst (#18605)
2021-07-29 10:50:17 +02:00
manual_experimental_strictnotnil.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
manual_experimental.rst
Remove Covariance section from the experimental manual (#18688)
2021-08-29 10:42:52 +02:00
manual.rst
manual: Document the use of static as a proc call (#19084)
2021-11-03 06:48:30 +01:00
mytest.cfg
'#' value parcing is explained (disambiguated) (#12476)
2019-10-25 15:22:26 +02:00
nep1.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
nimc.rst
cross compilation targetting windows now supports nim r: nim r -d:mingw main (#18682)
2021-08-16 09:32:12 +02:00
nimdoc.css
docgen: implement doc link resolution in current module (#18642)
2021-10-28 19:20:52 +02:00
nimfix.rst
RST backtick refactor (all *.rst except manual.rst and rst_examples.rst) (#17258)
2021-03-18 20:37:55 -07:00
nimgrep_cmdline.txt
update nimgrep documentation (#17415)
2021-03-23 18:12:27 +01:00
nimgrep.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
niminst.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
nims.rst
Update nims.rst to reflect that -d:release is now allowed in config.nims (#18221)
2021-06-10 14:29:03 +02:00
nimsuggest.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
overview.rst
further cleanups; refs #4934
2016-10-24 12:20:51 +02:00
packaging.rst
Document how to compile a reproducible build (#18953)
2021-10-06 09:41:42 +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
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
small improvements for tut1.rst (#17935)
2021-05-05 07:44:33 +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.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
tools.rst
follow-up #18013 - inline syntax highlighting (#18166)
2021-06-04 16:16:51 +02:00
tut1.rst
[backport] change some examples in tut1.rst (#18884)
2021-09-24 11:24:55 +02:00
tut2.rst
Add commas to docs for clarity (#18398)
2021-06-29 19:21:30 -07:00
tut3.rst
turn on syntax highlighting in Manual & Tutorial (#17692)
2021-04-11 10:23:08 +02: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!