Annotate sidebar_links(project) param + return type

This commit is contained in:
Sybren A. Stüvel 2017-05-24 15:47:05 +02:00
parent 43a04880e0
commit b7bccfeee3

View File

@ -17,6 +17,8 @@ can then be registered to the application at app creation time:
import abc import abc
import pillarsdk
class PillarExtension(object, metaclass=abc.ABCMeta): class PillarExtension(object, metaclass=abc.ABCMeta):
@property @property
@ -94,7 +96,7 @@ class PillarExtension(object, metaclass=abc.ABCMeta):
def setup_app(self, app): def setup_app(self, app):
"""Called during app startup, after all extensions have loaded.""" """Called during app startup, after all extensions have loaded."""
def sidebar_links(self, project): def sidebar_links(self, project: pillarsdk.Project) -> str:
"""Returns the sidebar link(s) for the given projects. """Returns the sidebar link(s) for the given projects.
:returns: HTML as a string for the sidebar. :returns: HTML as a string for the sidebar.