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

document that multiple yield in inline iterator cause code bloat (#10553)

Browse source 
* document that multiple `yield` in inline iterator cause code duplication
* doc: rule `Start types with a capital T` was deprecated
This commit is contained in:
Timothee Cour 2019-02-05 04:05:26 -08:00 • committed by Andreas Rumpf
commit 2b30998159
2 changed files with 10 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/intern.rst
View file

@ -67,8 +67,8 @@ Coding Guidelines
* Max line length is 80 characters. * Max line length is 80 characters.
* Provide spaces around binary operators if that enhances readability. * Provide spaces around binary operators if that enhances readability.
* Use a space after a colon, but not before it. * Use a space after a colon, but not before it.
* Start types with a capital ``T``, unless they are pointers/references which * [deprecated] Start types with a capital ``T``, unless they are
start with ``P``. pointers/references which start with ``P``.
See also the `API naming design <apis.html>`_ document. See also the `API naming design <apis.html>`_ document.

9
doc/manual.rst
View file

@ -3870,7 +3870,14 @@ First class iterators
There are 2 kinds of iterators in Nim: *inline* and *closure* iterators. There are 2 kinds of iterators in Nim: *inline* and *closure* iterators.
An `inline iterator`:idx: is an iterator that's always inlined by the compiler An `inline iterator`:idx: is an iterator that's always inlined by the compiler
leading to zero overhead for the abstraction, but may result in a heavy leading to zero overhead for the abstraction, but may result in a heavy
increase in code size. Inline iterators are second class citizens; increase in code size.
Caution: the body of a for loop over an inline iterator is inlined into
each ``yield`` statement appearing in the iterator code,
so ideally the code should be refactored to contain a single yield when possible
to avoid code bloat.
Inline iterators are second class citizens;
They can be passed as parameters only to other inlining code facilities like They can be passed as parameters only to other inlining code facilities like
templates, macros and other inline iterators. templates, macros and other inline iterators.