This commit is contained in:
Andreas Rumpf
2018-04-11 16:43:34 +02:00
parent e7edc7ec7f
commit 5e1e1a9145

View File

@@ -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
------------------