From cb4a7796f0cc71865b8e68e7fc2dce0e7b1f2473 Mon Sep 17 00:00:00 2001 From: Tom Kazimiers Date: Tue, 2 Jul 2024 21:46:25 +0200 Subject: [PATCH] Doc: minor change to title of compact skeleton API docs --- .../applications/catmaid/control/skeletonexport.py | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/django/applications/catmaid/control/skeletonexport.py b/django/applications/catmaid/control/skeletonexport.py index daea2a973a..2fde21fdc5 100644 --- a/django/applications/catmaid/control/skeletonexport.py +++ b/django/applications/catmaid/control/skeletonexport.py @@ -392,8 +392,10 @@ def compact_skeleton(request:HttpRequest, project_id=None, skeleton_id=None, @api_view(['POST']) @requires_user_role(UserRole.Browse) def compact_skeleton_detail_many(request:HttpRequest, project_id=None) -> Union[HttpResponse, JsonResponse]: - """Get a compact treenode representation of a list of skeletons, optionally - with the history of individual nodes and connectors. + """Get a compact treenode representation of a list of skeletons + + The returned data can optionally with the history of individual nodes and + connectors. Returns, in JSON, [[nodes], [connectors], {nodeID: [tags]}], with connectors and tags being empty when 0 == with_connectors and 0 == @@ -522,9 +524,11 @@ def _compact_skeleton(project_id, skeleton_id, with_connectors=True, with_tags=True, with_history=False, with_merge_history=True, with_reviews=False, with_annotations=False, with_user_info=False, ordered=False, scale=None) -> Tuple[Tuple, Tuple, DefaultDict[Any, List], List, List]: - """Get a compact treenode representation of a skeleton, optionally with the - history of individual nodes and connector, reviews and annotationss. Note - this function is performance critical! Returns, in JSON: + """Get a compact treenode representation of a skeleton + + The returned data can optionally with the history of individual nodes and + connector, reviews and annotationss. Note this function is performance + critical! Returns, in JSON: [[nodes], [connectors], {nodeID: [tags]}, [reviews], [annotations]]