changeset 8976:1c8b3f9add7c stable

api docs: add placeholder docstrings where docstrings are missing They will hopefully soon be replaced by actual API documentation.
author Mads Kiilerich <mads@kiilerich.com>
date Tue, 05 Jan 2021 00:47:08 +0100
parents 9fe161e3b5ce
children 2244eb820732
files kallithea/controllers/api/api.py
diffstat 1 files changed, 9 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/kallithea/controllers/api/api.py	Tue Dec 27 20:25:59 2022 +0100
+++ b/kallithea/controllers/api/api.py	Tue Jan 05 00:47:08 2021 +0100
@@ -1476,6 +1476,9 @@
                           description=None,
                           owner=None,
                           parent=None):
+        """
+        TODO
+        """
         repo_group = get_repo_group_or_error(repogroupid)
         parent_repo_group_id = None if parent is None else get_repo_group_or_error(parent).group_id
 
@@ -1824,6 +1827,9 @@
     # permission check inside
     def get_changesets(self, repoid, start=None, end=None, start_date=None,
                        end_date=None, branch_name=None, reverse=False, with_file_list=False, max_revisions=None):
+        """
+        TODO
+        """
         repo = get_repo_or_error(repoid)
         if not HasRepoPermissionLevel('read')(repo.repo_name):
             raise JSONRPCError('Access denied to repo %s' % repo.repo_name)
@@ -1842,6 +1848,9 @@
 
     # permission check inside
     def get_changeset(self, repoid, raw_id, with_reviews=False):
+        """
+        TODO
+        """
         repo = get_repo_or_error(repoid)
         if not HasRepoPermissionLevel('read')(repo.repo_name):
             raise JSONRPCError('Access denied to repo %s' % repo.repo_name)