RST backtick refactor (all *.rst except manual.rst and rst_examples.rst) #17258
Conversation
|
quantimnot
force-pushed
the
rst_backtick_refactor
branch
from
6b4e174
to
41a09b2
Compare
| @@ -15,7 +15,7 @@ General Guidelines | |||
| and `nim doc` supports it. Likewise with rst files: `nim rst2html` will render those as monospace, and | |||
| adding `.. default-role:: code` to an rst file will also make those render as monospace when rendered directly | |||
| in tools such as github. | |||
| * In nim sources, for links, prefer `[link text](link.html)` to ``` `link text<link.html>`_ ``` | |||
| * In nim sources, for links, prefer `[link text](link.html)` to `` `link text<link.html>`_ `` | |||
| @@ -142,33 +143,33 @@ Merging usually merges maps and alias sets: nilabilities are merged like this: | |||
| else: | |||
| MaybeNil | |||
|
|
|||
| Special handling is for ``.isNil`` and `` == nil``, also for ``not``, ``and`` and ``or``. | |||
| Special handling is for `.isNil` and ` == nil`, also for `not`, `and` and `or`. | |||
There was a problem hiding this comment.
pre-existing, but renders badly because of the space that prevents interpretation
| @@ -102,7 +104,7 @@ String and character literals | |||
| ----------------------------- | |||
|
|
|||
| String literals are enclosed in double-quotes; character literals in single | |||
| quotes. Special characters are escaped with ``\``: ``\n`` means newline, ``\t`` | |||
| quotes. Special characters are escaped with ``\\``: ``\n`` means newline, ``\t`` | |||
There was a problem hiding this comment.
bad change; should be fixed in followup PR
| They are written with three quotes: ``""" ... """``; they can span over | ||
| multiple lines and the ``\`` is not an escape character either. They are very | ||
| They are written with three quotes: `""" ... """`; they can span over | ||
| multiple lines and the ``\\`` is not an escape character either. They are very |
|
|
||
| The operator's precedence is determined by its first character. The details | ||
| can be found in the manual. | ||
|
|
||
| To define a new operator enclose the operator in backticks "``": | ||
| To define a new operator enclose the operator in backticks "`": |
|
|
||
| .. code-block:: nim | ||
| proc `$` (x: myDataType): string = ... | ||
| # now the $ operator also works with myDataType, overloading resolution | ||
| # ensures that $ works for built-in types just like before | ||
|
|
||
| The "``" notation can also be used to call an operator just like any other | ||
| The "`" notation can also be used to call an operator just like any other |
There was a problem hiding this comment.
LGTM, I checked everything using the same technique as described in #17259 (review):
checking both the diff, as well as the rendered html files and checking that each difference (a very small number) is intentional, or noting un-intentional ones as TODO for a followup PR
timotheecour
added
the
TODO: followup needed
|
merged, same rationale as #17259 (comment) @quantimnot thanks for this and the other PR! could you please followup with a PR to address the above mentioned points? also, a separate PR welcome for finishing off the work started here: #17217 so we can finally turn the page on this :) |
|
Yeah, I'll try to follow up on this pr today or tomorrow. OT: The other work is GDB/LLDB/... extensions for Nim. I remember reading a comment from you regarding some |
|
I'm going to wait until #17315 is merged. |
…st) (nim-lang#17258) Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
|
@quantimnot #17315 has been merged, you can go ahead with followups for this PR as well as #17259
followup timotheecour#599 (comment) |
…st) (nim-lang#17258) Co-authored-by: quantimnot <quantimnot@users.noreply.github.com>
Added
.. default-role:: codedirective to all rst files except manual.rst.Replaced double backticks with single backticks and realign shifted table columns in all rst files except manual.rst.
Replaced triple backtick code blocks with
.. code-block:: nimcode blocks.