From 8b19807af6e2882782860e1b0e1967f77ec5483f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=A0=D0=BE=D0=BC=D0=B0=D0=BD=20=D0=94=D0=BE=D0=BD=D1=87?= =?UTF-8?q?=D0=B5=D0=BD=D0=BA=D0=BE?= Date: Thu, 8 Oct 2015 03:13:27 +0300 Subject: [PATCH] Relax the documented restrictions on IRenderable It doesn't necessarily have to return a string (as evidenced by FlattenList). --- master/docs/manual/cfg-properties.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/master/docs/manual/cfg-properties.rst b/master/docs/manual/cfg-properties.rst index 26c0c2d7abd..161f2e63c77 100644 --- a/master/docs/manual/cfg-properties.rst +++ b/master/docs/manual/cfg-properties.rst @@ -359,7 +359,7 @@ Custom Renderables If the options described above are not sufficient, more complex substitutions can be achieved by writing custom renderables. The :class:`~buildbot.interfaces.IRenderable` interface is simple - objects must provide a `getRenderingFor` method. -The method should take one argument - an :class:`~buildbot.interfaces.IProperties` provider - and should return a string or a deferred firing with a string. +The method should take one argument - an :class:`~buildbot.interfaces.IProperties` provider - and should return the rendered value or a deferred firing with one. Pass instances of the class anywhere other renderables are accepted. For example::