Commit graph

56 commits

Author SHA1 Message Date
Andrey Makarov
417b90a7e5
Improve Markdown code blocks & start moving docs to Markdown style (#19954)
- add additional parameters parsing (other implementations will just
  ignore them). E.g. if in RST we have:

  .. code:: nim
     :test: "nim c $1"

     ...

  then in Markdown that will be:

  ```nim test="nim c $1"
  ...
  ```

- implement Markdown interpretation of additional indentation which is
  less than 4 spaces (>=4 spaces is a code block but it's not
implemented yet). RST interpretes it as quoted block, for Markdown it's
just normal paragraphs.
- add separate `md2html` and `md2tex` commands. This is to separate
  Markdown behavior in cases when it diverges w.r.t. RST significantly —
most conspicously like in the case of additional indentation above, and
also currently the contradicting inline rule of Markdown is also turned
on only in `md2html` and `md2tex`. **Rationale:** mixing Markdown and
RST arbitrarily is a way to nowhere, we need to provide a way to fix the
particular behavior. Note that still all commands have **both** Markdown
and RST features **enabled**. In this PR `*.nim` files can be processed
only in Markdown mode, while `md2html` is for `*.md` files and
`rst2html` for `*.rst` files.
- rename `*.rst` files to `.*md` as our current default behavior is
  already Markdown-ish
- convert code blocks in `docgen.rst` to Markdown style as an example.
  Other code blocks will be converted in the follow-up PRs
- fix indentation inside Markdown code blocks — additional indentation
  is preserved there
- allow more than 3 backticks open/close blocks (tildas \~ are still not
  allowed to avoid conflict with RST adornment headings) see also
https://github.com/nim-lang/RFCs/issues/355
- better error messages
- (other) fix a bug that admonitions cannot be used in sandbox mode; fix
  annoying warning on line 2711
2022-07-15 19:27:54 +02:00
Andrey Makarov
4341b06f65
RST: improve simple tables (#19859)
* RST: improve simple tables

* nim 1.0 gotchas

* Still allow legacy boundaries like `----`
2022-06-04 07:03:03 +02:00
flywind
891329cd4b
move io out of system (#19442)
* move io out of system

* fix tests

* fix tests

* next step

* rename to syncio

* rename

* fix nimscript

* comma

* fix

* fix parts of errors

* good for now

* fix test
2022-02-02 17:10:11 +01:00
Nan Xiao
39a27783fc
docs: Fix typo in tut1.rst (#19324) 2022-01-04 10:42:21 +01:00
Nan Xiao
bd4f76a2e3
docs: Fix typo in tut1.rst (#19309) 2022-01-03 10:30:26 +01:00
PMunch
c658de24b0
Improve documentation around func and method (#19207)
* Improve documentation around func and method

* Update doc/tut1.rst

Co-authored-by: Danil Yarantsev <tiberiumk12@gmail.com>

* Update doc/tut1.rst

Co-authored-by: Danil Yarantsev <tiberiumk12@gmail.com>

* Update doc/tut1.rst

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

* Update doc/tut1.rst

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

* Update doc/tut1.rst

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

* Update doc/tut1.rst

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

* Update doc/tut1.rst

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

* Update doc/tut1.rst

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

* Update doc/tut1.rst

Co-authored-by: Zoom <ZoomRmc@users.noreply.github.com>

* Update doc/tut1.rst

Co-authored-by: Zoom <ZoomRmc@users.noreply.github.com>

* Update doc/tut1.rst

Co-authored-by: Zoom <ZoomRmc@users.noreply.github.com>

* Update doc/tut1.rst

Co-authored-by: Zoom <ZoomRmc@users.noreply.github.com>

* Rewrite of Zooms suggestion

* Update doc/tut1.rst

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

Co-authored-by: Danil Yarantsev <tiberiumk12@gmail.com>
Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
Co-authored-by: Zoom <ZoomRmc@users.noreply.github.com>
2021-12-04 07:54:11 +01:00
Miran
561b01004c
[backport] change some examples in tut1.rst (#18884)
* [backport] change some examples in tut1.rst

* Update doc/tut1.rst

* Update doc/tut1.rst

Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
2021-09-24 11:24:55 +02:00
quantimnot
c792154b03
Minor doc fixes; follow up to 17258 and 17259 (#18123)
Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
2021-05-29 12:39:46 -07:00
Miran
94c4c01d9c
small improvements for tut1.rst (#17935)
* small improvements for tut1.rst
* remove unneeded paragraph
* Update doc/tut1.rst

Co-authored-by: Andreas Rumpf <rumpf_a@web.de>
2021-05-05 07:44:33 +02:00
Andrey Makarov
3aaec0647b
turn on syntax highlighting in Manual & Tutorial (#17692)
* turn on syntax highlighting in Manual & Tutorial

* avoid highlighting of "method"

* use relative path

* 2 more changes
2021-04-11 10:23:08 +02:00
Andreas Rumpf
643dbc743b
use strstr for a faster find implementation (#17672)
* use strstr for a faster find implementation
* stress the -d:release and -d:danger switches
2021-04-08 00:54:47 +02:00
quantimnot
83ae70cb54
RST backtick refactor (all *.rst except manual.rst and rst_examples.rst) (#17258)
Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
2021-03-18 20:37:55 -07:00
flywind
69a78c9183
promote std prefix in docs (#17128) 2021-02-20 22:38:29 -08:00
narimiran
2bedb0fe2c add link to Nim Basics in tut1.rst [ci skip] 2021-01-20 09:15:20 +01:00
Elliot Waite
f3d57761ab
Fix broken links in docs (#16336)
* Fix broken links in docs

* Fix rand HSlice links
2020-12-14 20:13:12 +01:00
Miran
1ad7e4f30b
fix #16047 (#16066) 2020-11-20 03:31:06 -08:00
Yanis Zafirópulos
0cae8ef2ca
Massive documentation fixes + copy editing (#15747) 2020-10-29 10:33:47 +01:00
Xavier Noria
25955440df
Document implicit return values from procedures (#15738) 2020-10-27 07:27:02 +01:00
Kaushal Modi
ac8ab4c549
Clarify the use of the backwards index operator (^N) in tut1 (#14681)
* Clarify the use of the backwards index operator (^N) in tut1

For consistency:
- Do `[a .. ^b]` (notice spaces on both sides of `..`)
- Do `[c ..< d]` (notice spaces on both sides of `..<`)

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

* tut1: Add a note that ^ template calls can be saved to consts
2020-06-19 10:22:48 -04:00
Kaushal Modi
e4ed19c12f
[backport] tut1: Update the proc overloading examples (#13497) [skip ci] 2020-02-25 21:19:51 +01:00
Siegfried Ehret
a577a88c36 Fix typo (#13015) [backport] 2020-01-03 10:23:28 +01:00
Timothee Cour
8c19372690 [ci skip] docfix .. < => ..< (#12981) [backport] 2019-12-29 15:34:36 +01:00
Elliot Waite
5da27a891c Removing the mention of using discard for block comments (#12837) [backport]
* Remove mention of using `discard` for block comments

* Add a 32x32 alternate favicon
2019-12-08 20:16:17 +01:00
Jjp137
3ad48069d3 Fix word wrapping 2019-10-22 17:59:12 -07:00
Jjp137
93461aee34 Fix many broken links
Note that contrary to what docgen.rst currently says, the ids have
to match exactly or else most web browsers will not jump to the
intended symbol.
2019-10-22 17:59:12 -07:00
pietroppeter
89c37fada7 [doc/tut1] removed discard discussion in comments (#12352) 2019-10-08 09:08:38 +02:00
Simon Krauter
e2f99a2026 Update tut1: -d:release does not turn off *allruntime checks off anymore (#11492)
According to https://nim-lang.org/blog/2019/06/06/version-0200-released.html
"The -d:release switch now does not disable runtime checks anymore. "
2019-06-13 15:16:38 +02:00
Arne Döring
80992c7a12 introduce object before tuple in the tutorials (#10664) 2019-02-14 22:17:05 +01:00
Araq
6fd0a33265 Tutorial 1: Simplifiy the discription of enums; it is a tutorial, not a manual 2018-08-31 00:30:19 +02:00
Στέφανος
f87a91a3ec Fixed a minor typo (#8685) 2018-08-20 09:40:56 +02:00
Chris de Graaf
6eedac3207 Fix link to first class iterator docs (#8356) 2018-07-18 09:17:34 +02:00
mboratko
70664bd1a2 Changed tutorial documentation referring to 'constant' to 'immutable' (#8056)
* Changed tutorial documentation referring to 'constant' to 'immutable'

* Clarification regarding side-effect free procedures fo:r multiple assignments
2018-06-18 02:05:35 -04:00
Andreas Rumpf
d62fe7d538 update the documentation 2018-05-01 09:38:17 +02:00
Andreas Rumpf
5237ef4f52 update the documentation about the new strings/seqs behaviours 2018-04-29 08:14:00 +02:00
Andreas Rumpf
fc52dd6463 Tut 1: tiny improvements 2018-02-05 21:13:18 +01:00
smt
e7e0648829
Update two links in tutorial to compiler usage docs with updated page anchors
Seems like these class ids on the page were renamed to reflect their hierarchy but the tutorial links weren't pointing to them, this should fix that
2018-01-12 13:57:58 +00:00
Araq
21ffb3a706 tut1.rst makes use of the new ':test:' feature 2017-11-28 01:15:33 +01:00
Araq
c1782fac21 cleaned up tutorial 1 2017-11-26 01:07:01 +01:00
Mamy Ratsimbazafy
e7c09512d2 Documentation: directly use ref object + fields (#6598) 2017-11-15 22:01:28 +01:00
superfunc
248caaf27e Update docs on assignment operator (#6373) 2017-09-15 21:49:00 +02:00
Andreas Rumpf
44bd4d8774 fixes #6125 2017-07-22 17:20:33 +02:00
Andreas Rumpf
6ba9c2b119 fixes #6062 2017-07-09 12:09:25 +02:00
Mice Pápai
f5717490d9 tut1.rst: Fix alignment, Change Subrange to MySubrange for clarity (#5798)
* tut1.rst: Fix alignment

* tut1.rst: Change Subrange to MySubrange for clarity
2017-05-13 21:52:19 +02:00
Mice Pápai
2e7551f17e Fix a typo in the Result variable block 2017-05-10 14:04:38 +02:00
jlp765
c8954b2b34 tut1.rst: Slices indices explanation (#5569) 2017-03-22 01:04:37 +01:00
mark-summerfield
9fda97b058 Fixed typo (#5508) 2017-03-12 20:01:01 +01:00
mark-summerfield
ef59b1a8eb Nicer English (#5513) 2017-03-12 19:55:14 +01:00
mark-summerfield
974b4d59b4 Nicer English (#5511) 2017-03-12 17:55:30 +01:00
mark-summerfield
c1ce20594e Nicer English (#5514) 2017-03-12 17:49:48 +01:00
mark-summerfield
639f786e5d Update tut1.rst (#5510)
In general: s/have to/must/g - but you can't do this mechanically because sometimes the must has to go back a word (e.g., line 519).

This looks really odd to me:
if thisIsaLongCondition() and
    thisIsAnotherLongCondition(1,
       2, 3, 4):
  x = true

I would have expected:
if thisIsaLongCondition() and
    thisIsAnotherLongCondition(
       1, 2, 3, 4):
  x = true

If the second form is valid and good Nim style then I suggest using it rather than the original. However, if the original is the preferred style then this should be mentioned in the text since it is unusual.

Since Nim is case-sensitive I think it is bad to write wrongly cased names, e.g., ``Bool`` is a built-in type on line 589. This isn't true since Bool isn't anything, but bool is. So in these cases I'd always reword to avoid this problem (and that's what I've done -- and it also avoids "bool. Bool" which was ugly).
2017-03-12 17:44:33 +01:00