openlp-core team mailing list archive

[Raoul Snyman <raoul.snyman@xxxxxxxxxxxxxxxxxxxxxxxx>]

Review: Needs Fixing
It looks like you're trying to achieve some formatting in that HideMode docstring? Unfortunately that is not valid reStructuredText, which is what docstrings should be formatted in. Here's a better formatting:


    """
    This is an enumeration class which specifies the different modes of hiding
    the display.

    ``Blank``
        This mode is used to hide all output, specifically by covering the
        display with a black screen.
        
    ``Theme``
        This mode is used to hide all output, but covers the display with the
        current theme background, as opposed to black.
        
    ``Desktop``
        This mode hides all output by minimising the display, leaving the user's
        desktop showing.
    """

This will display nicely in the API docs: http://docs.openlp.org/
-- 
https://code.launchpad.net/~m2j/openlp/work/+merge/45104
Your team OpenLP Core is subscribed to branch lp:openlp.