Skip to content

Commit 22669ec

Browse files
committed
core: Improve the documentation in core.rt.format on Sink and SinkArg.
1 parent bc67795 commit 22669ec

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

rt/src/core/rt/format.volt

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,18 @@
33
module core.rt.format;
44

55

6-
/// The one true sink definition.
6+
/*!
7+
* The argument that is passed to Sinks.
8+
*/
79
alias SinkArg = scope const(char)[];
810

9-
/// The argument to the one true sink.
11+
/*!
12+
* The Sink delegate.
13+
*
14+
* A Sink is a delegate that takes a `SinkArg`,
15+
* and builds a string, usually with an aim
16+
* to minimise needless allocations and GC calls.
17+
*/
1018
alias Sink = scope dg (SinkArg);
1119

1220
/*!

0 commit comments

Comments
 (0)