Skip to content

Commit

Permalink
[#2362] add some header text for page
Browse files Browse the repository at this point in the history
  • Loading branch information
tobes committed Jul 2, 2012
1 parent 4bc343f commit da078d7
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion ckan/plugins/toolkit.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,20 @@ class _Toolkit(object):
'aslist': 'part of paste.deploy.converters: convert string objects to a list',
}

header = '''
Toolkit
=======
To allow a safe way for extensions to interact with ckan a toolkit is provided. We aim to keep this toolkit stable across ckan versions so that extensions will work across diferent versions of ckan.
It is advised that when writing extensions that all interaction with ckan is done via the toolkit so that they do not break when new versions of ckan are released.
Over time we will be expanding the functionality available via this toolkit.
'''


def __init__(self):
self._toolkit = {}

Expand Down Expand Up @@ -262,7 +276,7 @@ def _function_info(self, functions):

def _document(self):
self._initialize()
out = 'Toolkit:\n--------\n\n'
out = self.header
functions = {}
functions = copy.copy(self._toolkit)
del functions['c']
Expand Down

0 comments on commit da078d7

Please sign in to comment.