Skip to content

Commit

Permalink
Relax the documented restrictions on IRenderable
Browse files Browse the repository at this point in the history
It doesn't necessarily have to return a string (as evidenced by
FlattenList).
  • Loading branch information
SpecLad committed Oct 8, 2015
1 parent 37b0fc2 commit 8b19807
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion master/docs/manual/cfg-properties.rst
Expand Up @@ -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::

Expand Down

0 comments on commit 8b19807

Please sign in to comment.