From 121cb32e085fd7c47aced9e96d28cd9bb3bb5a01 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 16 Jan 2018 14:19:48 -0500 Subject: [PATCH] fix field list markup syntax Fix the indentation for some field lists in controller methods to eliminate warnings in the documentation build. Change-Id: I3b53a58d8c0de4d7550235414ccb7e25df8327c2 Signed-off-by: Doug Hellmann --- storyboard/api/v1/boards.py | 12 +++++++----- storyboard/api/v1/worklists.py | 16 +++++++++------- 2 files changed, 16 insertions(+), 12 deletions(-) diff --git a/storyboard/api/v1/boards.py b/storyboard/api/v1/boards.py index 92d58426..58241986 100644 --- a/storyboard/api/v1/boards.py +++ b/storyboard/api/v1/boards.py @@ -259,11 +259,13 @@ class BoardsController(rest.RestController): :param archived: Filter boards by whether they are archived or not. :param story_id: Filter boards by whether they contain a story. :param task_id: Filter boards by whether they contain a task. - :param item_type: Used when filtering by story_id. If item_type is - 'story' then only return worklists that contain the story, if - item_type is 'task' then only return worklists that contain tasks from - the story, otherwise return worklists that contain the story or tasks - from the story. + :param item_type: Used when filtering by story_id. If + item_type is 'story' then only return + worklists that contain the story, if + item_type is 'task' then only return + worklists that contain tasks from the story, + otherwise return worklists that contain the + story or tasks from the story. :param offset: Value to offset results by. :param limit: Maximum number of results to return. :param sort_field: The name of the field to sort on. diff --git a/storyboard/api/v1/worklists.py b/storyboard/api/v1/worklists.py index 7ecbb841..9e8b5ebd 100644 --- a/storyboard/api/v1/worklists.py +++ b/storyboard/api/v1/worklists.py @@ -637,16 +637,18 @@ class WorklistsController(rest.RestController): :param story_id: Filter worklists by whether they contain a story. :param task_id: Filter worklists by whether they contain a task. :param hide_lanes: If true, don't return worklists which are lanes in - a board. + a board. :param sort_field: The name of the field to sort on. :param sort_dir: Sort direction for results (asc, desc). - :param item_type: Used when filtering by story_id. If item_type is - 'story' then only return worklists that contain the story, if - item_type is 'task' then only return worklists that contain tasks from - the story, otherwise return worklists that contain the story or tasks - from the story. + :param item_type: Used when filtering by story_id. If + item_type is 'story' then only return + worklists that contain the story, if + item_type is 'task' then only return + worklists that contain tasks from the story, + otherwise return worklists that contain the + story or tasks from the story. :param board_id: Get all worklists in the board with this id. Other - filters are not applied. + filters are not applied. :param subscriber_id: Filter worklists by whether a user is subscribed. :param offset: Offset at which to begin the results. :param limit: Maximum number of results to return.