jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

follow-up #18013 - inline syntax highlighting (#18166)

Browse source
This commit is contained in:
Andrey Makarov 2021-06-04 17:16:51 +03:00 • committed by GitHub
commit 7e21218a07
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
20 changed files with 183 additions and 164 deletions
Download patch file Download diff file Expand all files Collapse all files

11
doc/nep1.rst
View file

@ -1,11 +1,12 @@
.. default-role:: code
==========================================================
Nim Enhancement Proposal #1 - Standard Library Style Guide
==========================================================
:Author: Clay Sweetser, Dominik Picheta
:Version: |nimversion|
.. default-role:: code
.. include:: rstcommon.rst
.. contents::
@ -139,7 +140,7 @@ Naming Conventions
- rotate and rotated
- When the 'returns transformed copy' version already exists like `strutils.replace`
an in-place version should get an `-In` suffix (`replaceIn` for this example).
an in-place version should get an ``-In`` suffix (`replaceIn` for this example).
- Use `subjectVerb`, not `verbSubject`, e.g.: `fileExists`, not `existsFile`.
@ -225,8 +226,8 @@ indentation indent
Coding Conventions
------------------
- The 'return' statement should ideally be used when its control-flow properties
are required. Use a procedure's implicit 'result' variable whenever possible.
- The `return` statement should ideally be used when its control-flow properties
are required. Use a procedure's implicit `result` variable whenever possible.
This improves readability.
.. code-block:: nim