diff options
author | Andreas Rumpf <rumpf_a@web.de> | 2018-04-11 16:43:34 +0200 |
---|---|---|
committer | Andreas Rumpf <rumpf_a@web.de> | 2018-04-11 23:26:20 +0200 |
commit | 5e1e1a91455018a3ca5f732bb768550fd9381221 (patch) | |
tree | 782fe0c9e38de7cae266da4a55f4beae1ced4b34 | |
parent | e7edc7ec7f5990c80f0bb1ff9d1cd7f0b000bb0e (diff) | |
download | Nim-5e1e1a91455018a3ca5f732bb768550fd9381221.tar.gz |
fixes #7551
-rw-r--r-- | doc/nep1.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/nep1.rst b/doc/nep1.rst index d44265193..6924a86f6 100644 --- a/doc/nep1.rst +++ b/doc/nep1.rst @@ -134,6 +134,18 @@ changed in the future. as what they are: Real words. So it's ``parseUrl`` rather than ``parseURL``, ``checkHttpHeader`` instead of ``checkHTTPHeader`` etc. +- Operations like ``mitems`` or ``mpairs`` (or the now deprecated ``mget``) + that allow a *mutating view* into some data structure should start with an ``m``. +- When both in-place mutation and 'returns transformed copy' are available the latter + is a past participle of the former: + + - reverse and reversed in algorithm + - sort and sorted + - 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). + Coding Conventions ------------------ |