Are RST files supposed to be human-readably: yes, it's a format similar to 
Markdown which is intended to be possible to read, but also easily convertible 
to more "rich" content like websites or print.

>From your topic it appears you're not reading the raw RST file however, but 
>rather GitHubs rendering of them. GitHub and the Nim compiler uses two 
>different RST parsers, and thus render the files slightly differently. It is 
>possible to write GitHub-compliant RST that also complies with the Nim 
>compiler, however this is a bit finicky to get right as it is extremely strict 
>about whitespace. In general I'd say you should either read the official docs, 
>or the raw RST output for the best experience. The fact that GitHub is able to 
>render the RST files is more of a coincidence than anything.

P.S.: the link you shared to the manual is for an old version of Nim, the 
latest version can be found here: <https://nim-lang.org/docs/manual.html>

Reply via email to